GetKey

Use this data source to get detailed information about the specified KMS Key with flexible key id input. This can be useful to reference key alias without having to hard code the ARN as input.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var foo = Output.Create(Aws.Kms.GetKey.InvokeAsync(new Aws.Kms.GetKeyArgs
        {
            KeyId = "arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
        }));
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/kms"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := kms.LookupKey(ctx, &kms.LookupKeyArgs{
            KeyId: "arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
        }, nil)
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

foo = aws.kms.get_key(key_id="arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab")

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

const foo = pulumi.output(aws.kms.getKey({
    keyId: "arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
}, { async: true }));

Using GetKey

function getKey(args: GetKeyArgs, opts?: InvokeOptions): Promise<GetKeyResult>

function  get_key(grant_tokens=None, key_id=None, opts=None)

func LookupKey(ctx *Context, args *LookupKeyArgs, opts ...InvokeOption) (*LookupKeyResult, error)

Note: This function is named LookupKey in the Go SDK.

public static class GetKey {
    public static Task<GetKeyResult> InvokeAsync(GetKeyArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

KeyId string: Key identifier which can be one of the following format: * Key ID. E.g: 1234abcd-12ab-34cd-56ef-1234567890ab * Key ARN. E.g.: arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab * Alias name. E.g.: alias/my-key * Alias ARN: E.g.: arn:aws:kms:us-east-1:111122223333:alias/my-key
GrantTokens List<string>: List of grant tokens

KeyId string: Key identifier which can be one of the following format: * Key ID. E.g: 1234abcd-12ab-34cd-56ef-1234567890ab * Key ARN. E.g.: arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab * Alias name. E.g.: alias/my-key * Alias ARN: E.g.: arn:aws:kms:us-east-1:111122223333:alias/my-key
GrantTokens []string: List of grant tokens

keyId string: Key identifier which can be one of the following format: * Key ID. E.g: 1234abcd-12ab-34cd-56ef-1234567890ab * Key ARN. E.g.: arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab * Alias name. E.g.: alias/my-key * Alias ARN: E.g.: arn:aws:kms:us-east-1:111122223333:alias/my-key
grantTokens string[]: List of grant tokens

key_id str: Key identifier which can be one of the following format: * Key ID. E.g: 1234abcd-12ab-34cd-56ef-1234567890ab * Key ARN. E.g.: arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab * Alias name. E.g.: alias/my-key * Alias ARN: E.g.: arn:aws:kms:us-east-1:111122223333:alias/my-key
grant_tokens List[str]: List of grant tokens