AWS Native v0.126.0, Sep 30 24

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.kms.Key

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 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.

Create Key Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Key(name: string, args?: KeyArgs, opts?: CustomResourceOptions);

@overload
def Key(resource_name: str,
        args: Optional[KeyArgs] = None,
        opts: Optional[ResourceOptions] = None)

@overload
def Key(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        bypass_policy_lockout_safety_check: Optional[bool] = None,
        description: Optional[str] = None,
        enable_key_rotation: Optional[bool] = None,
        enabled: Optional[bool] = None,
        key_policy: Optional[Any] = None,
        key_spec: Optional[KeySpec] = None,
        key_usage: Optional[KeyUsage] = None,
        multi_region: Optional[bool] = None,
        origin: Optional[KeyOrigin] = None,
        pending_window_in_days: Optional[int] = None,
        rotation_period_in_days: Optional[int] = None,
        tags: Optional[Sequence[_root_inputs.TagArgs]] = None)

func NewKey(ctx *Context, name string, args *KeyArgs, opts ...ResourceOption) (*Key, error)

public Key(string name, KeyArgs? args = null, CustomResourceOptions? opts = null)

public Key(String name, KeyArgs args)
public Key(String name, KeyArgs args, CustomResourceOptions options)

type: aws-native:kms:Key
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args KeyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args KeyArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args KeyArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args KeyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args KeyArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Key Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Key resource accepts the following input properties:

BypassPolicyLockoutSafetyCheck bool

Skips ("bypasses") the key policy lockout safety check. The default value is false. Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately. For more information, see Default key policy in the Developer Guide. Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.

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.

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 (encryption and decryption or signing and verification)
RSA_2048
RSA_3072
RSA_4096
Asymmetric NIST-recommended elliptic curve key pairs (signing and verification or deriving shared secrets)
ECC_NIST_P256 (secp256r1)
ECC_NIST_P384 (secp384r1)
ECC_NIST_P521 (secp521r1)
Other asymmetric elliptic curve key pairs (signing and verification)
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
SM2 key pairs (encryption and decryption or signing and verification or deriving shared secrets)
SM2 (China Regions only)

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 parameter or specify ENCRYPT_DECRYPT.
For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC.
For asymmetric KMS keys with RSA key pairs, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
For asymmetric KMS keys with NIST-recommended elliptic curve key pairs, specify SIGN_VERIFY or KEY_AGREEMENT.
For asymmetric KMS keys with ECC_SECG_P256K1 key pairs specify SIGN_VERIFY.
For asymmetric KMS keys with SM2 key pairs (China Regions only), specify ENCRYPT_DECRYPT, SIGN_VERIFY, or KEY_AGREEMENT.

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.

PendingWindowInDays int

Specifies the number of days in the waiting period before KMS deletes a KMS key that has been removed from a CloudFormation stack. Enter a value between 7 and 30 days. The default value is 30 days. When you remove a KMS key from a CloudFormation stack, KMS schedules the KMS key for deletion and starts the mandatory waiting period. The PendingWindowInDays property determines the length of waiting period. During the waiting period, the key state of KMS key is Pending Deletion or Pending Replica Deletion, which prevents the KMS key from being used in cryptographic operations. When the waiting period expires, KMS permanently deletes the KMS key. KMS will not delete a multi-Region primary key that has replica keys. If you remove a multi-Region primary key from a CloudFormation stack, its key state changes to PendingReplicaDeletion so it cannot be replicated or used in cryptographic operations. This state can persist indefinitely. When the last of its replica keys is deleted, the key state of the primary key changes to PendingDeletion and the waiting period specified by PendingWindowInDays begins. When this waiting period expires, KMS deletes the primary key. For details, see Deleting multi-Region keys in the Developer Guide. You cannot use a CloudFormation template to cancel deletion of the KMS key after you remove it from the stack, regardless of the waiting period. If you specify a KMS key in your template, even one with the same name, CloudFormation creates a new KMS key. To cancel deletion of a KMS key, use the KMS console or the CancelKeyDeletion operation. For information about the Pending Deletion and Pending Replica Deletion key states, see Key state: Effect on your KMS key in the Developer Guide. For more information about deleting KMS keys, see the ScheduleKeyDeletion operation in the API Reference and Deleting KMS keys in the Developer Guide.

RotationPeriodInDays int

Specifies a custom period of time between each rotation date. If no value is specified, the default value is 365 days. The rotation period defines the number of days after you enable automatic key rotation that KMS will rotate your key material, and the number of days between each automatic rotation thereafter. You can use the kms:RotationPeriodInDays condition key to further constrain the values that principals can specify in the RotationPeriodInDays parameter. For more information about rotating KMS keys and automatic rotation, see Rotating keys in the Developer Guide.

Tags List<Pulumi.AwsNative.Inputs.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.

BypassPolicyLockoutSafetyCheck bool

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

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 (encryption and decryption or signing and verification)
RSA_2048
RSA_3072
RSA_4096
Asymmetric NIST-recommended elliptic curve key pairs (signing and verification or deriving shared secrets)
ECC_NIST_P256 (secp256r1)
ECC_NIST_P384 (secp384r1)
ECC_NIST_P521 (secp521r1)
Other asymmetric elliptic curve key pairs (signing and verification)
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
SM2 key pairs (encryption and decryption or signing and verification or deriving shared secrets)
SM2 (China Regions only)

KeyUsage KeyUsage

For symmetric encryption KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.
For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC.
For asymmetric KMS keys with RSA key pairs, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
For asymmetric KMS keys with NIST-recommended elliptic curve key pairs, specify SIGN_VERIFY or KEY_AGREEMENT.
For asymmetric KMS keys with ECC_SECG_P256K1 key pairs specify SIGN_VERIFY.
For asymmetric KMS keys with SM2 key pairs (China Regions only), specify ENCRYPT_DECRYPT, SIGN_VERIFY, or KEY_AGREEMENT.

MultiRegion bool

Origin KeyOrigin

PendingWindowInDays int

RotationPeriodInDays int

Tags TagArgs

bypassPolicyLockoutSafetyCheck Boolean

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

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 (encryption and decryption or signing and verification)
RSA_2048
RSA_3072
RSA_4096
Asymmetric NIST-recommended elliptic curve key pairs (signing and verification or deriving shared secrets)
ECC_NIST_P256 (secp256r1)
ECC_NIST_P384 (secp384r1)
ECC_NIST_P521 (secp521r1)
Other asymmetric elliptic curve key pairs (signing and verification)
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
SM2 key pairs (encryption and decryption or signing and verification or deriving shared secrets)
SM2 (China Regions only)

keyUsage KeyUsage

For symmetric encryption KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.
For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC.
For asymmetric KMS keys with RSA key pairs, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
For asymmetric KMS keys with NIST-recommended elliptic curve key pairs, specify SIGN_VERIFY or KEY_AGREEMENT.
For asymmetric KMS keys with ECC_SECG_P256K1 key pairs specify SIGN_VERIFY.
For asymmetric KMS keys with SM2 key pairs (China Regions only), specify ENCRYPT_DECRYPT, SIGN_VERIFY, or KEY_AGREEMENT.

multiRegion Boolean

origin KeyOrigin

pendingWindowInDays Integer

rotationPeriodInDays Integer

tags List<Tag>

bypassPolicyLockoutSafetyCheck boolean

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

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 (encryption and decryption or signing and verification)
RSA_2048
RSA_3072
RSA_4096
Asymmetric NIST-recommended elliptic curve key pairs (signing and verification or deriving shared secrets)
ECC_NIST_P256 (secp256r1)
ECC_NIST_P384 (secp384r1)
ECC_NIST_P521 (secp521r1)
Other asymmetric elliptic curve key pairs (signing and verification)
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
SM2 key pairs (encryption and decryption or signing and verification or deriving shared secrets)
SM2 (China Regions only)

keyUsage KeyUsage

For symmetric encryption KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.
For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC.
For asymmetric KMS keys with RSA key pairs, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
For asymmetric KMS keys with NIST-recommended elliptic curve key pairs, specify SIGN_VERIFY or KEY_AGREEMENT.
For asymmetric KMS keys with ECC_SECG_P256K1 key pairs specify SIGN_VERIFY.
For asymmetric KMS keys with SM2 key pairs (China Regions only), specify ENCRYPT_DECRYPT, SIGN_VERIFY, or KEY_AGREEMENT.

multiRegion boolean

origin KeyOrigin

pendingWindowInDays number

rotationPeriodInDays number

tags Tag[]

bypass_policy_lockout_safety_check bool

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_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 (encryption and decryption or signing and verification)
RSA_2048
RSA_3072
RSA_4096
Asymmetric NIST-recommended elliptic curve key pairs (signing and verification or deriving shared secrets)
ECC_NIST_P256 (secp256r1)
ECC_NIST_P384 (secp384r1)
ECC_NIST_P521 (secp521r1)
Other asymmetric elliptic curve key pairs (signing and verification)
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
SM2 key pairs (encryption and decryption or signing and verification or deriving shared secrets)
SM2 (China Regions only)

key_usage KeyUsage

For symmetric encryption KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.
For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC.
For asymmetric KMS keys with RSA key pairs, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
For asymmetric KMS keys with NIST-recommended elliptic curve key pairs, specify SIGN_VERIFY or KEY_AGREEMENT.
For asymmetric KMS keys with ECC_SECG_P256K1 key pairs specify SIGN_VERIFY.
For asymmetric KMS keys with SM2 key pairs (China Regions only), specify ENCRYPT_DECRYPT, SIGN_VERIFY, or KEY_AGREEMENT.

multi_region bool

origin KeyOrigin

pending_window_in_days int

rotation_period_in_days int

tags Sequence[TagArgs]

bypassPolicyLockoutSafetyCheck Boolean

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

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 (encryption and decryption or signing and verification)
RSA_2048
RSA_3072
RSA_4096
Asymmetric NIST-recommended elliptic curve key pairs (signing and verification or deriving shared secrets)
ECC_NIST_P256 (secp256r1)
ECC_NIST_P384 (secp384r1)
ECC_NIST_P521 (secp521r1)
Other asymmetric elliptic curve key pairs (signing and verification)
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
SM2 key pairs (encryption and decryption or signing and verification or deriving shared secrets)
SM2 (China Regions only)

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

For symmetric encryption KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.
For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC.
For asymmetric KMS keys with RSA key pairs, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
For asymmetric KMS keys with NIST-recommended elliptic curve key pairs, specify SIGN_VERIFY or KEY_AGREEMENT.
For asymmetric KMS keys with ECC_SECG_P256K1 key pairs specify SIGN_VERIFY.
For asymmetric KMS keys with SM2 key pairs (China Regions only), specify ENCRYPT_DECRYPT, SIGN_VERIFY, or KEY_AGREEMENT.

multiRegion Boolean

origin "AWS_KMS" | "EXTERNAL"

pendingWindowInDays Number

rotationPeriodInDays Number

tags List<Property Map>

Outputs

All input properties are implicitly available as output properties. Additionally, the Key resource produces the following output properties:

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 .

Id string

The provider-assigned unique ID for this managed resource.

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 .

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 .

Id string

The provider-assigned unique ID for this managed resource.

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 .

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 .

id String

The provider-assigned unique ID for this managed resource.

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 .

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 .

id string

The provider-assigned unique ID for this managed resource.

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 .

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 .

id str

The provider-assigned unique ID for this managed resource.

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 .

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 .

id String

The provider-assigned unique ID for this managed resource.

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 .

Supporting Types

KeyOrigin, KeyOriginArgs

AwsKms: AWS_KMS
External: EXTERNAL

KeyOriginAwsKms: AWS_KMS
KeyOriginExternal: EXTERNAL

AwsKms: AWS_KMS
External: EXTERNAL

AwsKms: AWS_KMS
External: EXTERNAL

AWS_KMS: AWS_KMS
EXTERNAL: EXTERNAL

"AWS_KMS": AWS_KMS
"EXTERNAL": EXTERNAL

KeySpec, KeySpecArgs

SymmetricDefault: SYMMETRIC_DEFAULT
Rsa2048: RSA_2048
Rsa3072: RSA_3072
Rsa4096: RSA_4096
EccNistP256: ECC_NIST_P256
EccNistP384: ECC_NIST_P384
EccNistP521: ECC_NIST_P521
EccSecgP256k1: ECC_SECG_P256K1
Hmac224: HMAC_224
Hmac256: HMAC_256
Hmac384: HMAC_384
Hmac512: HMAC_512
Sm2: SM2

KeySpecSymmetricDefault: SYMMETRIC_DEFAULT
KeySpecRsa2048: RSA_2048
KeySpecRsa3072: RSA_3072
KeySpecRsa4096: RSA_4096
KeySpecEccNistP256: ECC_NIST_P256
KeySpecEccNistP384: ECC_NIST_P384
KeySpecEccNistP521: ECC_NIST_P521
KeySpecEccSecgP256k1: ECC_SECG_P256K1
KeySpecHmac224: HMAC_224
KeySpecHmac256: HMAC_256
KeySpecHmac384: HMAC_384
KeySpecHmac512: HMAC_512
KeySpecSm2: SM2

SymmetricDefault: SYMMETRIC_DEFAULT
Rsa2048: RSA_2048
Rsa3072: RSA_3072
Rsa4096: RSA_4096
EccNistP256: ECC_NIST_P256
EccNistP384: ECC_NIST_P384
EccNistP521: ECC_NIST_P521
EccSecgP256k1: ECC_SECG_P256K1
Hmac224: HMAC_224
Hmac256: HMAC_256
Hmac384: HMAC_384
Hmac512: HMAC_512
Sm2: SM2

SymmetricDefault: SYMMETRIC_DEFAULT
Rsa2048: RSA_2048
Rsa3072: RSA_3072
Rsa4096: RSA_4096
EccNistP256: ECC_NIST_P256
EccNistP384: ECC_NIST_P384
EccNistP521: ECC_NIST_P521
EccSecgP256k1: ECC_SECG_P256K1
Hmac224: HMAC_224
Hmac256: HMAC_256
Hmac384: HMAC_384
Hmac512: HMAC_512
Sm2: SM2

SYMMETRIC_DEFAULT: SYMMETRIC_DEFAULT
RSA2048: RSA_2048
RSA3072: RSA_3072
RSA4096: RSA_4096
ECC_NIST_P256: ECC_NIST_P256
ECC_NIST_P384: ECC_NIST_P384
ECC_NIST_P521: ECC_NIST_P521
ECC_SECG_P256K1: ECC_SECG_P256K1
HMAC224: HMAC_224
HMAC256: HMAC_256
HMAC384: HMAC_384
HMAC512: HMAC_512
SM2: SM2

"SYMMETRIC_DEFAULT": SYMMETRIC_DEFAULT
"RSA_2048": RSA_2048
"RSA_3072": RSA_3072
"RSA_4096": RSA_4096
"ECC_NIST_P256": ECC_NIST_P256
"ECC_NIST_P384": ECC_NIST_P384
"ECC_NIST_P521": ECC_NIST_P521
"ECC_SECG_P256K1": ECC_SECG_P256K1
"HMAC_224": HMAC_224
"HMAC_256": HMAC_256
"HMAC_384": HMAC_384
"HMAC_512": HMAC_512
"SM2": SM2

KeyUsage, KeyUsageArgs

EncryptDecrypt: ENCRYPT_DECRYPT
SignVerify: SIGN_VERIFY
GenerateVerifyMac: GENERATE_VERIFY_MAC
KeyAgreement: KEY_AGREEMENT

KeyUsageEncryptDecrypt: ENCRYPT_DECRYPT
KeyUsageSignVerify: SIGN_VERIFY
KeyUsageGenerateVerifyMac: GENERATE_VERIFY_MAC
KeyUsageKeyAgreement: KEY_AGREEMENT

EncryptDecrypt: ENCRYPT_DECRYPT
SignVerify: SIGN_VERIFY
GenerateVerifyMac: GENERATE_VERIFY_MAC
KeyAgreement: KEY_AGREEMENT

EncryptDecrypt: ENCRYPT_DECRYPT
SignVerify: SIGN_VERIFY
GenerateVerifyMac: GENERATE_VERIFY_MAC
KeyAgreement: KEY_AGREEMENT

ENCRYPT_DECRYPT: ENCRYPT_DECRYPT
SIGN_VERIFY: SIGN_VERIFY
GENERATE_VERIFY_MAC: GENERATE_VERIFY_MAC
KEY_AGREEMENT: KEY_AGREEMENT

"ENCRYPT_DECRYPT": ENCRYPT_DECRYPT
"SIGN_VERIFY": SIGN_VERIFY
"GENERATE_VERIFY_MAC": GENERATE_VERIFY_MAC
"KEY_AGREEMENT": KEY_AGREEMENT

Tag, TagArgs

Key string: The key name of the tag
Value string: The value of the tag

Key string: The key name of the tag
Value string: The value of the tag

key String: The key name of the tag
value String: The value of the tag

key string: The key name of the tag
value string: The value of the tag

key str: The key name of the tag
value str: The value of the tag

key String: The key name of the tag
value String: The value of the tag

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.kms.Key

On this page

On this page

Create Key Resource

Constructor syntax

Parameters

Key Resource Properties

Inputs

Outputs

Supporting Types

KeyOrigin, KeyOriginArgs

KeySpec, KeySpecArgs

KeyUsage, KeyUsageArgs

Tag, TagArgs

Package Details

On this page

On this page