getDefaultKmsKey function

Future<GetDefaultKmsKeyResult> getDefaultKmsKey(
  1. GetDefaultKmsKeyArgs args, {
  2. InvokeOptions? options,
})

Use this data source to get the default EBS encryption KMS key in the current region.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const current = aws.ebs.getDefaultKmsKey({});
const example = new aws.ebs.Volume("example", {
    availabilityZone: "us-west-2a",
    encrypted: true,
    kmsKeyId: current.then(current => current.keyArn),
});
import pulumi
import pulumi_aws as aws

current = aws.ebs.get_default_kms_key()
example = aws.ebs.Volume("example",
    availability_zone="us-west-2a",
    encrypted=True,
    kms_key_id=current.key_arn)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var current = Aws.Ebs.GetDefaultKmsKey.Invoke();

    var example = new Aws.Ebs.Volume("example", new()
    {
        AvailabilityZone = "us-west-2a",
        Encrypted = true,
        KmsKeyId = current.Apply(getDefaultKmsKeyResult => getDefaultKmsKeyResult.KeyArn),
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ebs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		current, err := ebs.LookupDefaultKmsKey(ctx, &ebs.LookupDefaultKmsKeyArgs{}, nil)
		if err != nil {
			return err
		}
		_, err = ebs.NewVolume(ctx, "example", &ebs.VolumeArgs{
			AvailabilityZone: pulumi.String("us-west-2a"),
			Encrypted:        pulumi.Bool(true),
			KmsKeyId:         pulumi.String(current.KeyArn),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_ebs_getdefaultkmskey" "current" {
}

resource "aws_ebs_volume" "example" {
  availability_zone = "us-west-2a"
  encrypted         = true
  kms_key_id        = data.aws_ebs_getdefaultkmskey.current.key_arn
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ebs.EbsFunctions;
import com.pulumi.aws.ebs.inputs.GetDefaultKmsKeyArgs;
import com.pulumi.aws.ebs.Volume;
import com.pulumi.aws.ebs.VolumeArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var current = EbsFunctions.getDefaultKmsKey(GetDefaultKmsKeyArgs.builder()
            .build());

        var example = new Volume("example", VolumeArgs.builder()
            .availabilityZone("us-west-2a")
            .encrypted(true)
            .kmsKeyId(current.keyArn())
            .build());

    }
}
resources:
  example:
    type: aws:ebs:Volume
    properties:
      availabilityZone: us-west-2a
      encrypted: true
      kmsKeyId: ${current.keyArn}
variables:
  current:
    fn::invoke:
      function: aws:ebs:getDefaultKmsKey
      arguments: {}

args Arguments passed to this invoke. Arguments for getDefaultKmsKey. options Invoke options controlling this call.

Implementation

Future<GetDefaultKmsKeyResult> getDefaultKmsKey(
  GetDefaultKmsKeyArgs args, {
  pulumi.InvokeOptions? options,
}) async {
  final deployment = pulumi.Deployment.instance;
  final result = await deployment.invoke<Map<String, dynamic>>(
    'aws:ebs/getDefaultKmsKey:getDefaultKmsKey',
    args.toMap(),
    options: pulumi.toDeploymentInvokeOptions(options),
  );
  return GetDefaultKmsKeyResult.fromMap(result);
}