AWS Native v0.109.0, Jun 26 24

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.kms.getKey

Explore with Pulumi AI

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi

pulumi/pulumi-aws-native

The AWS::KMS::Key resource specifies an KMS key in KMSlong. You can use this resource to create symmetric encryption KMS keys, asymmetric KMS keys for encryption or signing, and symmetric HMAC KMS keys. You can use AWS::KMS::Key to create multi-Region primary keys of all supported types. To replicate a multi-Region key, use the AWS::KMS::ReplicaKey resource. If you change the value of the KeySpec, KeyUsage, Origin, or MultiRegion properties of an existing KMS key, the update request fails, regardless of the value of the UpdateReplacePolicy attribute. This prevents you from accidentally deleting a KMS key by changing any of its immutable property values. KMS replaced the term customer master key (CMK) with ** and KMS key. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term. You can use symmetric encryption KMS keys to encrypt and decrypt small amounts of data, but they are more commonly used to generate data keys and data key pairs. You can also use a symmetric encryption KMS key to encrypt data stored in AWS services that are integrated with. For more information, see Symmetric encryption KMS keys in the Developer Guide. You can use asymmetric KMS keys to encrypt and decrypt data or sign messages and verify signatures. To create an asymmetric key, you must specify an asymmetric KeySpec value and a KeyUsage value. For details, see Asymmetric keys in in the Developer Guide. You can use HMAC KMS keys (which are also symmetric keys) to generate and verify hash-based message authentication codes. To create an HMAC key, you must specify an HMAC KeySpec value and a KeyUsage value of GENERATE_VERIFY_MAC. For details, see HMAC keys in in the Developer Guide. You can also create symmetric encryption, asymmetric, and HMAC multi-Region primary keys. To create a multi-Region primary key, set the MultiRegion property to true. For information about multi-Region keys, see Multi-Region keys in in the Developer Guide. You cannot use the AWS::KMS::Key resource to specify a KMS key with imported key material or a KMS key in a custom key store. Regions KMS CloudFormation resources are available in all Regions in which KMS and CFN are supported. You can use the AWS::KMS::Key resource to create and manage all KMS key types that are supported in a Region.

Using getKey

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

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

def get_key(key_id: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetKeyResult
def get_key_output(key_id: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetKeyResult]

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

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

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

public static CompletableFuture<GetKeyResult> getKey(GetKeyArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws-native:kms:getKey
  arguments:
    # arguments dictionary

The following arguments are supported:

KeyId string

The key ID of the KMS key, such as 1234abcd-12ab-34cd-56ef-1234567890ab .

For information about the key ID of a KMS key, see Key ID in the AWS Key Management Service Developer Guide .

KeyId string

The key ID of the KMS key, such as 1234abcd-12ab-34cd-56ef-1234567890ab .

For information about the key ID of a KMS key, see Key ID in the AWS Key Management Service Developer Guide .

keyId String

The key ID of the KMS key, such as 1234abcd-12ab-34cd-56ef-1234567890ab .

For information about the key ID of a KMS key, see Key ID in the AWS Key Management Service Developer Guide .

keyId string

The key ID of the KMS key, such as 1234abcd-12ab-34cd-56ef-1234567890ab .

For information about the key ID of a KMS key, see Key ID in the AWS Key Management Service Developer Guide .

key_id str

The key ID of the KMS key, such as 1234abcd-12ab-34cd-56ef-1234567890ab .

For information about the key ID of a KMS key, see Key ID in the AWS Key Management Service Developer Guide .

keyId String

The key ID of the KMS key, such as 1234abcd-12ab-34cd-56ef-1234567890ab .

For information about the key ID of a KMS key, see Key ID in the AWS Key Management Service Developer Guide .

getKey Result

The following output properties are available:

Arn string

The Amazon Resource Name (ARN) of the KMS key, such as arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab .

For information about the key ARN of a KMS key, see Key ARN in the AWS Key Management Service Developer Guide .

Description string

A description of the KMS key. Use a description that helps you to distinguish this KMS key from others in the account, such as its intended use.

EnableKeyRotation bool

Enables automatic rotation of the key material for the specified KMS key. By default, automatic key rotation is not enabled. KMS supports automatic rotation only for symmetric encryption KMS keys (KeySpec = SYMMETRIC_DEFAULT). For asymmetric KMS keys, HMAC KMS keys, and KMS keys with Origin EXTERNAL, omit the EnableKeyRotation property or set it to false. To enable automatic key rotation of the key material for a multi-Region KMS key, set EnableKeyRotation to true on the primary key (created by using AWS::KMS::Key). KMS copies the rotation status to all replica keys. For details, see Rotating multi-Region keys in the Developer Guide. When you enable automatic rotation, KMS automatically creates new key material for the KMS key one year after the enable date and every year thereafter. KMS retains all key material until you delete the KMS key. For detailed information about automatic key rotation, see Rotating KMS keys in the Developer Guide.

Enabled bool

Specifies whether the KMS key is enabled. Disabled KMS keys cannot be used in cryptographic operations. When Enabled is true, the key state of the KMS key is Enabled. When Enabled is false, the key state of the KMS key is Disabled. The default value is true. The actual key state of the KMS key might be affected by actions taken outside of CloudFormation, such as running the EnableKey, DisableKey, or ScheduleKeyDeletion operations. For information about the key states of a KMS key, see Key state: Effect on your KMS key in the Developer Guide.

KeyId string

The key ID of the KMS key, such as 1234abcd-12ab-34cd-56ef-1234567890ab .

For information about the key ID of a KMS key, see Key ID in the AWS Key Management Service Developer Guide .

KeyPolicy object

The key policy to attach to the KMS key. If you provide a key policy, it must meet the following criteria:

The key policy must allow the caller to make a subsequent PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see Default key policy in the Developer Guide. (To omit this condition, set BypassPolicyLockoutSafetyCheck to true.)
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the User Guide.

If you do not provide a key policy, KMS attaches a default key policy to the KMS key. For more information, see Default key policy in the Developer Guide. A key policy document can include only the following characters:

Printable ASCII characters
Printable characters in the Basic Latin and Latin-1 Supplement character set
The tab (\u0009), line feed (\u000A), and carriage return (\u000D) special characters

Minimum: 1 Maximum: 32768

Search the CloudFormation User Guide for AWS::KMS::Key for more information about the expected schema for this property.

KeySpec Pulumi.AwsNative.Kms.KeySpec

Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT, creates a KMS key with a 256-bit symmetric key for encryption and decryption. In China Regions, SYMMETRIC_DEFAULT creates a 128-bit symmetric key that uses SM4 encryption. You can't change the KeySpec value after the KMS key is created. For help choosing a key spec for your KMS key, see Choosing a KMS key type in the Developer Guide. The KeySpec property determines the type of key material in the KMS key and the algorithms that the KMS key supports. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy. For more information, see condition keys in the Developer Guide. If you change the value of the KeySpec property on an existing KMS key, the update request fails, regardless of the value of the UpdateReplacePolicy attribute. This prevents you from accidentally deleting a KMS key by changing an immutable property value. services that are integrated with use symmetric encryption KMS keys to protect your data. These services do not support encryption with asymmetric KMS keys. For help determining whether a KMS key is asymmetric, see Identifying asymmetric KMS keys in the Developer Guide. KMS supports the following key specs for KMS keys:

Symmetric encryption key (default)
SYMMETRIC_DEFAULT (AES-256-GCM)
HMAC keys (symmetric)
HMAC_224
HMAC_256
HMAC_384
HMAC_512
Asymmetric RSA key pairs
RSA_2048
RSA_3072
RSA_4096
Asymmetric NIST-recommended elliptic curve key pairs
ECC_NIST_P256 (secp256r1)
ECC_NIST_P384 (secp384r1)
ECC_NIST_P521 (secp521r1)
Other asymmetric elliptic curve key pairs
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
SM2 key pairs (China Regions only)
SM2

KeyUsage Pulumi.AwsNative.Kms.KeyUsage

Determines the cryptographic operations for which you can use the KMS key. The default value is ENCRYPT_DECRYPT. This property is required for asymmetric KMS keys and HMAC KMS keys. You can't change the KeyUsage value after the KMS key is created. If you change the value of the KeyUsage property on an existing KMS key, the update request fails, regardless of the value of the UpdateReplacePolicy attribute. This prevents you from accidentally deleting a KMS key by changing an immutable property value. Select only one valid value.

For symmetric encryption KMS keys, omit the property or specify ENCRYPT_DECRYPT.
For asymmetric KMS keys with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
For asymmetric KMS keys with ECC key material, specify SIGN_VERIFY.
For asymmetric KMS keys with SM2 (China Regions only) key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
For HMAC KMS keys, specify GENERATE_VERIFY_MAC.

MultiRegion bool

Creates a multi-Region primary key that you can replicate in other AWS-Regions. You can't change the MultiRegion value after the KMS key is created. For a list of AWS-Regions in which multi-Region keys are supported, see Multi-Region keys in in the **. If you change the value of the MultiRegion property on an existing KMS key, the update request fails, regardless of the value of the UpdateReplacePolicy attribute. This prevents you from accidentally deleting a KMS key by changing an immutable property value. For a multi-Region key, set to this property to true. For a single-Region key, omit this property or set it to false. The default value is false. Multi-Region keys are an KMS feature that lets you create multiple interoperable KMS keys in different AWS-Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS-Region and decrypt it in a different AWS-Region without making a cross-Region call or exposing the plaintext data. For more information, see Multi-Region keys in the Developer Guide. You can create a symmetric encryption, HMAC, or asymmetric multi-Region KMS key, and you can create a multi-Region key with imported key material. However, you cannot create a multi-Region key in a custom key store. To create a replica of this primary key in a different AWS-Region , create an AWS::KMS::ReplicaKey resource in a CloudFormation stack in the replica Region. Specify the key ARN of this primary key.

Origin Pulumi.AwsNative.Kms.KeyOrigin

The source of the key material for the KMS key. You cannot change the origin after you create the KMS key. The default is AWS_KMS, which means that KMS creates the key material. To create a KMS key with no key material (for imported key material), set this value to EXTERNAL. For more information about importing key material into KMS, see Importing Key Material in the Developer Guide. You can ignore ENABLED when Origin is EXTERNAL. When a KMS key with Origin EXTERNAL is created, the key state is PENDING_IMPORT and ENABLED is false. After you import the key material, ENABLED updated to true. The KMS key can then be used for Cryptographic Operations. CFN doesn't support creating an Origin parameter of the AWS_CLOUDHSM or EXTERNAL_KEY_STORE values.

Tags List<Pulumi.AwsNative.Outputs.Tag>

Assigns one or more tags to the replica key. Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC for in the Developer Guide. For information about tags in KMS, see Tagging keys in the Developer Guide. For information about tags in CloudFormation, see Tag.

Arn string

The Amazon Resource Name (ARN) of the KMS key, such as arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab .

For information about the key ARN of a KMS key, see Key ARN in the AWS Key Management Service Developer Guide .

Description string

A description of the KMS key. Use a description that helps you to distinguish this KMS key from others in the account, such as its intended use.

EnableKeyRotation bool

Enabled bool

KeyId string

The key ID of the KMS key, such as 1234abcd-12ab-34cd-56ef-1234567890ab .

For information about the key ID of a KMS key, see Key ID in the AWS Key Management Service Developer Guide .

KeyPolicy interface{}

The key policy to attach to the KMS key. If you provide a key policy, it must meet the following criteria:

The key policy must allow the caller to make a subsequent PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see Default key policy in the Developer Guide. (To omit this condition, set BypassPolicyLockoutSafetyCheck to true.)
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the User Guide.

Printable ASCII characters
Printable characters in the Basic Latin and Latin-1 Supplement character set
The tab (\u0009), line feed (\u000A), and carriage return (\u000D) special characters

Minimum: 1 Maximum: 32768

Search the CloudFormation User Guide for AWS::KMS::Key for more information about the expected schema for this property.

KeySpec KeySpec

Symmetric encryption key (default)
SYMMETRIC_DEFAULT (AES-256-GCM)
HMAC keys (symmetric)
HMAC_224
HMAC_256
HMAC_384
HMAC_512
Asymmetric RSA key pairs
RSA_2048
RSA_3072
RSA_4096
Asymmetric NIST-recommended elliptic curve key pairs
ECC_NIST_P256 (secp256r1)
ECC_NIST_P384 (secp384r1)
ECC_NIST_P521 (secp521r1)
Other asymmetric elliptic curve key pairs
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
SM2 key pairs (China Regions only)
SM2

KeyUsage KeyUsage

For symmetric encryption KMS keys, omit the property or specify ENCRYPT_DECRYPT.
For asymmetric KMS keys with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
For asymmetric KMS keys with ECC key material, specify SIGN_VERIFY.
For asymmetric KMS keys with SM2 (China Regions only) key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
For HMAC KMS keys, specify GENERATE_VERIFY_MAC.

MultiRegion bool

Origin KeyOrigin

Tags Tag

arn String

The Amazon Resource Name (ARN) of the KMS key, such as arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab .

For information about the key ARN of a KMS key, see Key ARN in the AWS Key Management Service Developer Guide .

description String

A description of the KMS key. Use a description that helps you to distinguish this KMS key from others in the account, such as its intended use.

enableKeyRotation Boolean

enabled Boolean

keyId String

The key ID of the KMS key, such as 1234abcd-12ab-34cd-56ef-1234567890ab .

For information about the key ID of a KMS key, see Key ID in the AWS Key Management Service Developer Guide .

keyPolicy Object

The key policy to attach to the KMS key. If you provide a key policy, it must meet the following criteria:

The key policy must allow the caller to make a subsequent PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see Default key policy in the Developer Guide. (To omit this condition, set BypassPolicyLockoutSafetyCheck to true.)
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the User Guide.

Printable ASCII characters
Printable characters in the Basic Latin and Latin-1 Supplement character set
The tab (\u0009), line feed (\u000A), and carriage return (\u000D) special characters

Minimum: 1 Maximum: 32768

Search the CloudFormation User Guide for AWS::KMS::Key for more information about the expected schema for this property.

keySpec KeySpec

Symmetric encryption key (default)
SYMMETRIC_DEFAULT (AES-256-GCM)
HMAC keys (symmetric)
HMAC_224
HMAC_256
HMAC_384
HMAC_512
Asymmetric RSA key pairs
RSA_2048
RSA_3072
RSA_4096
Asymmetric NIST-recommended elliptic curve key pairs
ECC_NIST_P256 (secp256r1)
ECC_NIST_P384 (secp384r1)
ECC_NIST_P521 (secp521r1)
Other asymmetric elliptic curve key pairs
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
SM2 key pairs (China Regions only)
SM2

keyUsage KeyUsage

For symmetric encryption KMS keys, omit the property or specify ENCRYPT_DECRYPT.
For asymmetric KMS keys with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
For asymmetric KMS keys with ECC key material, specify SIGN_VERIFY.
For asymmetric KMS keys with SM2 (China Regions only) key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
For HMAC KMS keys, specify GENERATE_VERIFY_MAC.

multiRegion Boolean

origin KeyOrigin

tags List<Tag>

arn string

The Amazon Resource Name (ARN) of the KMS key, such as arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab .

For information about the key ARN of a KMS key, see Key ARN in the AWS Key Management Service Developer Guide .

description string

A description of the KMS key. Use a description that helps you to distinguish this KMS key from others in the account, such as its intended use.

enableKeyRotation boolean

enabled boolean

keyId string

The key ID of the KMS key, such as 1234abcd-12ab-34cd-56ef-1234567890ab .

For information about the key ID of a KMS key, see Key ID in the AWS Key Management Service Developer Guide .

keyPolicy any

The key policy to attach to the KMS key. If you provide a key policy, it must meet the following criteria:

The key policy must allow the caller to make a subsequent PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see Default key policy in the Developer Guide. (To omit this condition, set BypassPolicyLockoutSafetyCheck to true.)
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the User Guide.

Printable ASCII characters
Printable characters in the Basic Latin and Latin-1 Supplement character set
The tab (\u0009), line feed (\u000A), and carriage return (\u000D) special characters

Minimum: 1 Maximum: 32768

Search the CloudFormation User Guide for AWS::KMS::Key for more information about the expected schema for this property.

keySpec KeySpec

Symmetric encryption key (default)
SYMMETRIC_DEFAULT (AES-256-GCM)
HMAC keys (symmetric)
HMAC_224
HMAC_256
HMAC_384
HMAC_512
Asymmetric RSA key pairs
RSA_2048
RSA_3072
RSA_4096
Asymmetric NIST-recommended elliptic curve key pairs
ECC_NIST_P256 (secp256r1)
ECC_NIST_P384 (secp384r1)
ECC_NIST_P521 (secp521r1)
Other asymmetric elliptic curve key pairs
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
SM2 key pairs (China Regions only)
SM2

keyUsage KeyUsage

For symmetric encryption KMS keys, omit the property or specify ENCRYPT_DECRYPT.
For asymmetric KMS keys with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
For asymmetric KMS keys with ECC key material, specify SIGN_VERIFY.
For asymmetric KMS keys with SM2 (China Regions only) key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
For HMAC KMS keys, specify GENERATE_VERIFY_MAC.

multiRegion boolean

origin KeyOrigin

tags Tag[]

arn str

The Amazon Resource Name (ARN) of the KMS key, such as arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab .

For information about the key ARN of a KMS key, see Key ARN in the AWS Key Management Service Developer Guide .

description str

A description of the KMS key. Use a description that helps you to distinguish this KMS key from others in the account, such as its intended use.

enable_key_rotation bool

enabled bool

key_id str

The key ID of the KMS key, such as 1234abcd-12ab-34cd-56ef-1234567890ab .

For information about the key ID of a KMS key, see Key ID in the AWS Key Management Service Developer Guide .

key_policy Any

The key policy to attach to the KMS key. If you provide a key policy, it must meet the following criteria:

The key policy must allow the caller to make a subsequent PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see Default key policy in the Developer Guide. (To omit this condition, set BypassPolicyLockoutSafetyCheck to true.)
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the User Guide.

Printable ASCII characters
Printable characters in the Basic Latin and Latin-1 Supplement character set
The tab (\u0009), line feed (\u000A), and carriage return (\u000D) special characters

Minimum: 1 Maximum: 32768

Search the CloudFormation User Guide for AWS::KMS::Key for more information about the expected schema for this property.

key_spec KeySpec

Symmetric encryption key (default)
SYMMETRIC_DEFAULT (AES-256-GCM)
HMAC keys (symmetric)
HMAC_224
HMAC_256
HMAC_384
HMAC_512
Asymmetric RSA key pairs
RSA_2048
RSA_3072
RSA_4096
Asymmetric NIST-recommended elliptic curve key pairs
ECC_NIST_P256 (secp256r1)
ECC_NIST_P384 (secp384r1)
ECC_NIST_P521 (secp521r1)
Other asymmetric elliptic curve key pairs
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
SM2 key pairs (China Regions only)
SM2

key_usage KeyUsage

For symmetric encryption KMS keys, omit the property or specify ENCRYPT_DECRYPT.
For asymmetric KMS keys with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
For asymmetric KMS keys with ECC key material, specify SIGN_VERIFY.
For asymmetric KMS keys with SM2 (China Regions only) key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
For HMAC KMS keys, specify GENERATE_VERIFY_MAC.

multi_region bool

origin KeyOrigin

tags Sequence[root_Tag]

arn String

The Amazon Resource Name (ARN) of the KMS key, such as arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab .

For information about the key ARN of a KMS key, see Key ARN in the AWS Key Management Service Developer Guide .

description String

A description of the KMS key. Use a description that helps you to distinguish this KMS key from others in the account, such as its intended use.

enableKeyRotation Boolean

enabled Boolean

keyId String

The key ID of the KMS key, such as 1234abcd-12ab-34cd-56ef-1234567890ab .

For information about the key ID of a KMS key, see Key ID in the AWS Key Management Service Developer Guide .

keyPolicy Any

The key policy to attach to the KMS key. If you provide a key policy, it must meet the following criteria:

The key policy must allow the caller to make a subsequent PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see Default key policy in the Developer Guide. (To omit this condition, set BypassPolicyLockoutSafetyCheck to true.)
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the User Guide.

Printable ASCII characters
Printable characters in the Basic Latin and Latin-1 Supplement character set
The tab (\u0009), line feed (\u000A), and carriage return (\u000D) special characters

Minimum: 1 Maximum: 32768

Search the CloudFormation User Guide for AWS::KMS::Key for more information about the expected schema for this property.

Symmetric encryption key (default)
SYMMETRIC_DEFAULT (AES-256-GCM)
HMAC keys (symmetric)
HMAC_224
HMAC_256
HMAC_384
HMAC_512
Asymmetric RSA key pairs
RSA_2048
RSA_3072
RSA_4096
Asymmetric NIST-recommended elliptic curve key pairs
ECC_NIST_P256 (secp256r1)
ECC_NIST_P384 (secp384r1)
ECC_NIST_P521 (secp521r1)
Other asymmetric elliptic curve key pairs
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
SM2 key pairs (China Regions only)
SM2

keyUsage "ENCRYPT_DECRYPT" | "SIGN_VERIFY" | "GENERATE_VERIFY_MAC" | "KEY_AGREEMENT"

For symmetric encryption KMS keys, omit the property or specify ENCRYPT_DECRYPT.
For asymmetric KMS keys with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
For asymmetric KMS keys with ECC key material, specify SIGN_VERIFY.
For asymmetric KMS keys with SM2 (China Regions only) key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
For HMAC KMS keys, specify GENERATE_VERIFY_MAC.

multiRegion Boolean

origin "AWS_KMS" | "EXTERNAL"

tags List<Property Map>