This is the new *Amazon CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [Amazon CloudFormation User Guide](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/Welcome.html). # AWS::KMS::Key The `AWS::KMS::Key` resource specifies an [KMS key](https://docs.amazonaws.cn/kms/latest/developerguide/concepts.html#kms_keys) in Amazon Key Management Service. 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](https://docs.amazonaws.cn/kms/latest/developerguide/multi-region-keys-overview.html#mrk-primary-key) of all supported types. To replicate a multi-Region key, use the `AWS::KMS::ReplicaKey` resource. **Important** 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](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing any of its immutable property values. **Note** Amazon KMS replaced the term *customer master key (CMK)* with * Amazon KMS key * and *KMS key*. The concept has not changed. To prevent breaking changes, Amazon 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 Amazon services that are [integrated with Amazon KMS](https://www.amazonaws.cn//kms/features/#AWS_Service_Integration). For more information, see [Symmetric encryption KMS keys](https://docs.amazonaws.cn/kms/latest/developerguide/concepts.html#symmetric-cmks) in the *Amazon Key Management Service 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 Amazon KMS](https://docs.amazonaws.cn/kms/latest/developerguide/symmetric-asymmetric.html) in the *Amazon Key Management Service 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 Amazon KMS](https://docs.amazonaws.cn/kms/latest/developerguide/hmac.html) in the *Amazon Key Management Service 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 Amazon KMS](https://docs.amazonaws.cn/kms/latest/developerguide/multi-region-keys-overview.html) in the *Amazon Key Management Service Developer Guide*. You cannot use the `AWS::KMS::Key` resource to specify a KMS key with [imported key material](https://docs.amazonaws.cn/kms/latest/developerguide/importing-keys.html) or a KMS key in a [custom key store](https://docs.amazonaws.cn/kms/latest/developerguide/custom-key-store-overview.html). **Regions** Amazon KMS CloudFormation resources are available in all Regions in which Amazon KMS and Amazon CloudFormation are supported. You can use the `AWS::KMS::Key` resource to create and manage all KMS key types that are supported in a Region. ## Syntax To declare this entity in your Amazon CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::KMS::Key", "Properties" : { "[BypassPolicyLockoutSafetyCheck](#cfn-kms-key-bypasspolicylockoutsafetycheck)" : {{Boolean}}, "[Description](#cfn-kms-key-description)" : {{String}}, "[Enabled](#cfn-kms-key-enabled)" : {{Boolean}}, "[EnableKeyRotation](#cfn-kms-key-enablekeyrotation)" : {{Boolean}}, "[KeyPolicy](#cfn-kms-key-keypolicy)" : {{Json}}, "[KeySpec](#cfn-kms-key-keyspec)" : {{String}}, "[KeyUsage](#cfn-kms-key-keyusage)" : {{String}}, "[MultiRegion](#cfn-kms-key-multiregion)" : {{Boolean}}, "[Origin](#cfn-kms-key-origin)" : {{String}}, "[PendingWindowInDays](#cfn-kms-key-pendingwindowindays)" : {{Integer}}, "[RotationPeriodInDays](#cfn-kms-key-rotationperiodindays)" : {{Integer}}, "[Tags](#cfn-kms-key-tags)" : {{[ Tag, ... ]}} } } ``` ### YAML ``` Type: AWS::KMS::Key Properties: [BypassPolicyLockoutSafetyCheck](#cfn-kms-key-bypasspolicylockoutsafetycheck): {{Boolean}} [Description](#cfn-kms-key-description): {{String}} [Enabled](#cfn-kms-key-enabled): {{Boolean}} [EnableKeyRotation](#cfn-kms-key-enablekeyrotation): {{Boolean}} [KeyPolicy](#cfn-kms-key-keypolicy): {{Json}} [KeySpec](#cfn-kms-key-keyspec): {{String}} [KeyUsage](#cfn-kms-key-keyusage): {{String}} [MultiRegion](#cfn-kms-key-multiregion): {{Boolean}} [Origin](#cfn-kms-key-origin): {{String}} [PendingWindowInDays](#cfn-kms-key-pendingwindowindays): {{Integer}} [RotationPeriodInDays](#cfn-kms-key-rotationperiodindays): {{Integer}} [Tags](#cfn-kms-key-tags): {{ - Tag}} ``` ## Properties `BypassPolicyLockoutSafetyCheck` 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](https://docs.amazonaws.cn/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key) in the *Amazon Key Management Service Developer Guide*. Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent [PutKeyPolicy](https://docs.amazonaws.cn/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Description` 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. *Required*: No *Type*: String *Minimum*: `0` *Maximum*: `8192` *Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Enabled` 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](https://docs.amazonaws.cn/kms/latest/APIReference/API_EnableKey.html), [DisableKey](https://docs.amazonaws.cn/kms/latest/APIReference/API_DisableKey.html), or [ScheduleKeyDeletion](https://docs.amazonaws.cn/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operations. For information about the key states of a KMS key, see [Key state: Effect on your KMS key](https://docs.amazonaws.cn/kms/latest/developerguide/key-state.html) in the *Amazon Key Management Service Developer Guide*. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `EnableKeyRotation` Enables automatic rotation of the key material for the specified KMS key. By default, automatic key rotation is not enabled. Amazon 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`). Amazon KMS copies the rotation status to all replica keys. For details, see [Rotating multi-Region keys](https://docs.amazonaws.cn/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate) in the *Amazon Key Management Service Developer Guide*. When you enable automatic rotation, Amazon KMS automatically creates new key material for the KMS key one year after the enable date and every year thereafter. Amazon KMS retains all key material until you delete the KMS key. For detailed information about automatic key rotation, see [Rotating KMS keys](https://docs.amazonaws.cn/kms/latest/developerguide/rotate-keys.html) in the *Amazon Key Management Service Developer Guide*. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `KeyPolicy` 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](https://docs.amazonaws.cn/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see [Default key policy](https://docs.amazonaws.cn/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) in the *Amazon Key Management Service 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 Amazon KMS. When you create a new Amazon 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 Amazon KMS. For more information, see [Changes that I make are not always immediately visible](https://docs.amazonaws.cn/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) in the *Amazon Identity and Access Management User Guide*. If you do not provide a key policy, Amazon KMS attaches a default key policy to the KMS key. For more information, see [Default key policy](https://docs.amazonaws.cn/kms/latest/developerguide/key-policies.html#key-policy-default) in the *Amazon Key Management Service 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` *Required*: No *Type*: Json *Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `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](https://docs.amazonaws.cn/kms/latest/developerguide/symm-asymm-choose.html) in the *Amazon Key Management Service 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 [Amazon KMS condition keys](https://docs.amazonaws.cn/kms/latest/developerguide/policy-conditions.html#conditions-kms) in the *Amazon Key Management Service 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](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value. [Amazon services that are integrated with Amazon KMS](https://www.amazonaws.cn/kms/features/#AWS_Service_Integration) 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](https://docs.amazonaws.cn/kms/latest/developerguide/find-symm-asymm.html) in the *Amazon Key Management Service Developer Guide*. Amazon 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) + `ECC_NIST_EDWARDS25519` (ed25519) - signing and verification only + **Note:** For ECC\_NIST\_EDWARDS25519 KMS keys, the ED25519\_SHA\_512 signing algorithm requires [https://docs.amazonaws.cn/kms/latest/APIReference/API_Sign.html#KMS-Sign-request-MessageType](https://docs.amazonaws.cn/kms/latest/APIReference/API_Sign.html#KMS-Sign-request-MessageType), while ED25519\_PH\_SHA\_512 requires [https://docs.amazonaws.cn/kms/latest/APIReference/API_Sign.html#KMS-Sign-request-MessageType](https://docs.amazonaws.cn/kms/latest/APIReference/API_Sign.html#KMS-Sign-request-MessageType). These message types cannot be used interchangeably. + Other asymmetric elliptic curve key pairs (signing and verification) + `ECC_SECG_P256K1` (secp256k1), commonly used for cryptocurrencies. + Asymmetric ML-DSA key pairs (signing and verification) + `ML_DSA_44` + `ML_DSA_65` + `ML_DSA_87` + SM2 key pairs (encryption and decryption *or* signing and verification *or* deriving shared secrets) + `SM2` (China Regions only) *Required*: No *Type*: String *Allowed values*: `SYMMETRIC_DEFAULT | RSA_2048 | RSA_3072 | RSA_4096 | ECC_NIST_P256 | ECC_NIST_P384 | ECC_NIST_P521 | ECC_SECG_P256K1 | HMAC_224 | HMAC_256 | HMAC_384 | HMAC_512 | SM2 | ML_DSA_44 | ML_DSA_65 | ML_DSA_87 | ECC_NIST_EDWARDS25519` *Update requires*: [Replacement](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `KeyUsage` Determines the [cryptographic operations](https://docs.amazonaws.cn/kms/latest/developerguide/concepts.html#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](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). 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 ML-DSA key pairs, specify `SIGN_VERIFY`. + For asymmetric KMS keys with SM2 key pairs (China Regions only), specify `ENCRYPT_DECRYPT`, `SIGN_VERIFY`, or `KEY_AGREEMENT`. *Required*: No *Type*: String *Allowed values*: `ENCRYPT_DECRYPT | SIGN_VERIFY | GENERATE_VERIFY_MAC | KEY_AGREEMENT` *Update requires*: [Replacement](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `MultiRegion` Creates a multi-Region primary key that you can replicate in other Amazon Web Services Regions. You can't change the `MultiRegion` value after the KMS key is created. For a list of Amazon Web Services Regions in which multi-Region keys are supported, see [Multi-Region keys in Amazon KMS](https://docs.amazonaws.cn/kms/latest/developerguide/multi-region-keys-overview.html) in the * Amazon Key Management Service Developer Guide *. 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](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). 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 Amazon KMS feature that lets you create multiple interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them to encrypt data in one Amazon Web Services Region and decrypt it in a different Amazon Web Services Region without making a cross-Region call or exposing the plaintext data. For more information, see [Multi-Region keys](https://docs.amazonaws.cn/kms/latest/developerguide/multi-region-keys-overview.html) in the *Amazon Key Management Service 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 Amazon Web Services Region , create an [AWS::KMS::ReplicaKey](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html) resource in a CloudFormation stack in the replica Region. Specify the key ARN of this primary key. *Required*: No *Type*: Boolean *Update requires*: [Replacement](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Origin` 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 Amazon KMS creates the key material. To [create a KMS key with no key material](https://docs.amazonaws.cn/kms/latest/developerguide/importing-keys-create-cmk.html) (for imported key material), set this value to `EXTERNAL`. For more information about importing key material into Amazon KMS, see [Importing Key Material](https://docs.amazonaws.cn/kms/latest/developerguide/importing-keys.html) in the *Amazon Key Management Service 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. + Amazon CloudFormation doesn't support creating an `Origin` parameter of the `AWS_CLOUDHSM` or `EXTERNAL_KEY_STORE` values. + `EXTERNAL` is not supported for ML-DSA keys. *Required*: No *Type*: String *Allowed values*: `AWS_KMS | EXTERNAL` *Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PendingWindowInDays` Specifies the number of days in the waiting period before Amazon 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, Amazon 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, Amazon KMS permanently deletes the KMS key. Amazon KMS will not delete a [multi-Region primary key](https://docs.amazonaws.cn/kms/latest/developerguide/multi-region-keys-overview.html) 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, Amazon KMS deletes the primary key. For details, see [Deleting multi-Region keys](https://docs.amazonaws.cn/kms/latest/developerguide/multi-region-keys-delete.html) in the *Amazon Key Management Service 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 Amazon KMS console or the [CancelKeyDeletion](https://docs.amazonaws.cn/kms/latest/APIReference/API_CancelKeyDeletion.html) operation. For information about the `Pending Deletion` and `Pending Replica Deletion` key states, see [Key state: Effect on your KMS key](https://docs.amazonaws.cn/kms/latest/developerguide/key-state.html) in the *Amazon Key Management Service Developer Guide*. For more information about deleting KMS keys, see the [ScheduleKeyDeletion](https://docs.amazonaws.cn/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operation in the *Amazon Key Management Service API Reference* and [Deleting KMS keys](https://docs.amazonaws.cn/kms/latest/developerguide/deleting-keys.html) in the *Amazon Key Management Service Developer Guide*. *Required*: No *Type*: Integer *Minimum*: `7` *Maximum*: `30` *Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RotationPeriodInDays` 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 Amazon KMS will rotate your key material, and the number of days between each automatic rotation thereafter. You can use the [https://docs.amazonaws.cn/kms/latest/developerguide/conditions-kms.html#conditions-kms-rotation-period-in-days](https://docs.amazonaws.cn/kms/latest/developerguide/conditions-kms.html#conditions-kms-rotation-period-in-days) 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](https://docs.amazonaws.cn/kms/latest/developerguide/rotate-keys.html) in the *Amazon Key Management Service Developer Guide*. *Required*: No *Type*: Integer *Minimum*: `90` *Maximum*: `2560` *Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tags` 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 Amazon KMS](https://docs.amazonaws.cn/kms/latest/developerguide/abac.html) in the *Amazon Key Management Service Developer Guide*. For information about tags in Amazon KMS, see [Tagging keys](https://docs.amazonaws.cn/kms/latest/developerguide/tagging-keys.html) in the *Amazon Key Management Service Developer Guide*. For information about tags in CloudFormation, see [Tag](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html). *Required*: No *Type*: Array of [Tag](aws-properties-kms-key-tag.md) *Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the key ID, such as `1234abcd-12ab-34cd-56ef-1234567890ab`. For more information about using the `Ref` function, see [https://docs.amazonaws.cn/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.amazonaws.cn/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.amazonaws.cn/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.amazonaws.cn/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `Arn` 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](https://docs.amazonaws.cn/kms/latest/developerguide/concepts.html#key-id-key-ARN) in the *Amazon Key Management Service Developer Guide*. `KeyId` 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](https://docs.amazonaws.cn/kms/latest/developerguide/concepts.html#key-id-key-id) in the *Amazon Key Management Service Developer Guide*. ## Examples **Topics** + [Create a symmetric encryption KMS key](#aws-resource-kms-key--examples--Create_a_symmetric_encryption_KMS_key) + [Create a symmetric encryption KMS key with a resource tag](#aws-resource-kms-key--examples--Create_a_symmetric_encryption_KMS_key_with_a_resource_tag) + [Create an asymmetric KMS key](#aws-resource-kms-key--examples--Create_an_asymmetric_KMS_key) + [Create an HMAC KMS key](#aws-resource-kms-key--examples--Create_an_HMAC_KMS_key) + [Create a multi-Region primary key](#aws-resource-kms-key--examples--Create_a_multi-Region_primary_key) ### Create a symmetric encryption KMS key The following example creates a symmetric encryption KMS key. The key policy for the KMS key allows `Alice` to manage the key and allows `Bob` to view the KMS key and use it in cryptographic operations. It also allows the Amazon Web Services account (root) full access to the key. This prevents you from losing control of the key if both `Alice` and `Bob` are deleted from the account. #### JSON ``` "myKey": { "Type": "AWS::KMS::Key", "Properties": { "Description": "An example symmetric encryption KMS key", "EnableKeyRotation": true, "PendingWindowInDays": 20, "KeyPolicy": { "Version": "2012-10-17", "Id": "key-default-1", "Statement": [ { "Sid": "Enable IAM User Permissions", "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::111122223333:root" }, "Action": "kms:*", "Resource": "*" }, { "Sid": "Allow administration of the key", "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::111122223333:user/Alice" }, "Action": [ "kms:Create*", "kms:Describe*", "kms:Enable*", "kms:List*", "kms:Put*", "kms:Update*", "kms:Revoke*", "kms:Disable*", "kms:Get*", "kms:Delete*", "kms:ScheduleKeyDeletion", "kms:CancelKeyDeletion" ], "Resource": "*" }, { "Sid": "Allow use of the key", "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::111122223333:user/Bob" }, "Action": [ "kms:DescribeKey", "kms:Encrypt", "kms:Decrypt", "kms:ReEncrypt*", "kms:GenerateDataKey", "kms:GenerateDataKeyWithoutPlaintext" ], "Resource": "*" } ] } } } ``` #### YAML ``` myKey: Type: 'AWS::KMS::Key' Properties: Description: An example symmetric encryption KMS key EnableKeyRotation: true PendingWindowInDays: 20 KeyPolicy: Version: 2012-10-17 Id: key-default-1 Statement: - Sid: Enable IAM User Permissions Effect: Allow Principal: AWS: 'arn:aws:iam::111122223333:root' Action: 'kms:*' Resource: '*' - Sid: Allow administration of the key Effect: Allow Principal: AWS: 'arn:aws:iam::111122223333:user/Alice' Action: - 'kms:Create*' - 'kms:Describe*' - 'kms:Enable*' - 'kms:List*' - 'kms:Put*' - 'kms:Update*' - 'kms:Revoke*' - 'kms:Disable*' - 'kms:Get*' - 'kms:Delete*' - 'kms:ScheduleKeyDeletion' - 'kms:CancelKeyDeletion' Resource: '*' - Sid: Allow use of the key Effect: Allow Principal: AWS: 'arn:aws:iam::111122223333:user/Bob' Action: - 'kms:DescribeKey' - 'kms:Encrypt' - 'kms:Decrypt' - 'kms:ReEncrypt*' - 'kms:GenerateDataKey' - 'kms:GenerateDataKeyWithoutPlaintext' Resource: '*' ``` ### Create a symmetric encryption KMS key with a resource tag The following example creates a symmetric encryption KMS key with one resource tag. **Note** Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see [ABAC for Amazon KMS](https://docs.amazonaws.cn/kms/latest/developerguide/abac.html) in the *Amazon Key Management Service Developer Guide*. #### JSON ``` "myKeyWithTag": { "Type": "AWS::KMS::Key", "Properties": { "KeyPolicy": { "Version": "2012-10-17", "Id": "key-default-1", "Statement": [ { "Sid": "Enable IAM User Permissions", "Effect": "Allow", "Principal": { "AWS": { "Fn::Join": [ "", [ "arn:aws:iam::", { "Ref": "AWS::AccountId" }, ":root" ] ] } }, "Action": "kms:*", "Resource": "*" } ] }, "Tags": [ { "Key": { "Ref": "Key" }, "Value": { "Ref": "Value" } } ] }, "Parameters": { "Key": { "Type": "String" }, "Value": { "Type": "String" } } } ``` #### YAML ``` myKeyWithTag: Type: 'AWS::KMS::Key' Properties: KeyPolicy: Version: 2012-10-17 Id: key-default-1 Statement: - Sid: Enable IAM User Permissions Effect: Allow Principal: AWS: !Join - '' - - 'arn:aws:iam::' - !Ref 'AWS::AccountId' - ':root' Action: 'kms:*' Resource: '*' Tags: - Key: !Ref Key Value: !Ref Value Parameters: Key: Type: String Value: Type: String ``` ### Create an asymmetric KMS key The following example creates an RSA asymmetric KMS key for signing and verification. For an asymmetric KMS key, you must specify `KeySpec` and `KeyUsage` properties. The `EnableKeyRotation` property must be omitted or set to `false`. #### JSON ``` "RSASigningKey": { "Type": "AWS::KMS::Key", "Properties": { "Description": "RSA-3072 asymmetric KMS key for signing and verification", "KeySpec": "RSA_3072", "KeyUsage": "SIGN_VERIFY", "KeyPolicy": { "Version": "2012-10-17", "Id": "key-default-1", "Statement": [ { "Sid": "Enable IAM User Permissions", "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::111122223333:root" }, "Action": "kms:*", "Resource": "*" }, { "Sid": "Allow administration of the key", "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::111122223333:role/Admin" }, "Action": [ "kms:Create*", "kms:Describe*", "kms:Enable*", "kms:List*", "kms:Put*", "kms:Update*", "kms:Revoke*", "kms:Disable*", "kms:Get*", "kms:Delete*", "kms:ScheduleKeyDeletion", "kms:CancelKeyDeletion" ], "Resource": "*" }, { "Sid": "Allow use of the key", "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::111122223333:role/Developer" }, "Action": [ "kms:Sign", "kms:Verify", "kms:DescribeKey" ], "Resource": "*" } ] } } } ``` #### YAML ``` RSASigningKey: Type: 'AWS::KMS::Key' Properties: Description: RSA-3072 asymmetric KMS key for signing and verification KeySpec: RSA_3072 KeyUsage: SIGN_VERIFY KeyPolicy: Version: 2012-10-17 Id: key-default-1 Statement: - Sid: Enable IAM User Permissions Effect: Allow Principal: AWS: 'arn:aws:iam::111122223333:root' Action: 'kms:*' Resource: '*' - Sid: Allow administration of the key Effect: Allow Principal: AWS: 'arn:aws:iam::111122223333:role/Admin' Action: - 'kms:Create*' - 'kms:Describe*' - 'kms:Enable*' - 'kms:List*' - 'kms:Put*' - 'kms:Update*' - 'kms:Revoke*' - 'kms:Disable*' - 'kms:Get*' - 'kms:Delete*' - 'kms:ScheduleKeyDeletion' - 'kms:CancelKeyDeletion' Resource: '*' - Sid: Allow use of the key Effect: Allow Principal: AWS: 'arn:aws:iam::111122223333:role/Developer' Action: - 'kms:Sign' - 'kms:Verify' - 'kms:DescribeKey' Resource: '*' ``` ### Create an HMAC KMS key The following example creates an HMAC KMS key. For an HMAC KMS key, you must specify an HMAC `KeySpec` and the GENERATE\_VERIFY\_MAC value for the `KeyUsage` property. Omit the `EnableKeyRotation` property or it set to `false`. #### JSON ``` { "HMACExampleKey": { "Type": "AWS::KMS::Key", "Properties": { "Description": "HMAC_384 key for tokens", "KeySpec": "HMAC_384", "KeyUsage": "GENERATE_VERIFY_MAC", "KeyPolicy": { "Version": "2012-10-17", "Id": "key-default-1", "Statement": [ { "Sid": "Enable IAM User Permissions", "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::111122223333:root" }, "Action": "kms:*", "Resource": "*" }, { "Sid": "Allow administration of the key", "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::111122223333:role/Admin" }, "Action": [ "kms:Create*", "kms:Describe*", "kms:Enable*", "kms:List*", "kms:Put*", "kms:Update*", "kms:Revoke*", "kms:Disable*", "kms:Get*", "kms:Delete*", "kms:ScheduleKeyDeletion", "kms:CancelKeyDeletion" ], "Resource": "*" }, { "Sid": "Allow use of the key", "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::111122223333:role/Developer" }, "Action": [ "kms:GenerateMac", "kms:VerifyMac", "kms:DescribeKey" ], "Resource": "*" } ] } } } } ``` #### YAML ``` HMACExampleKey: Type: 'AWS::KMS::Key' Properties: Description: HMAC_384 key for tokens KeySpec: HMAC_384 KeyUsage: GENERATE_VERIFY_MAC KeyPolicy: Version: 2012-10-17 Id: key-default-1 Statement: - Sid: Enable IAM User Permissions Effect: Allow Principal: AWS: 'arn:aws:iam::111122223333:root' Action: 'kms:*' Resource: '*' - Sid: Allow administration of the key Effect: Allow Principal: AWS: 'arn:aws:iam::111122223333:role/Admin' Action: - 'kms:Create*' - 'kms:Describe*' - 'kms:Enable*' - 'kms:List*' - 'kms:Put*' - 'kms:Update*' - 'kms:Revoke*' - 'kms:Disable*' - 'kms:Get*' - 'kms:Delete*' - 'kms:ScheduleKeyDeletion' - 'kms:CancelKeyDeletion' Resource: '*' - Sid: Allow use of the key Effect: Allow Principal: AWS: 'arn:aws:iam::111122223333:role/Developer' Action: - 'kms:GenerateMac' - 'kms:VerifyMac' - 'kms:DescribeKey' Resource: '*' ``` ### Create a multi-Region primary key The following example creates a multi-Region primary key. This example key is a symmetric encryption KMS key, but you can create multi-Region versions of asymmetric KMS keys and HMAC KMS keys. *Multi-Region keys* are an Amazon KMS feature that lets you create multiple interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them to encrypt data in one Amazon Web Services Region and decrypt it in a different Amazon Web Services Region without making a cross-Region call or exposing the plaintext data. For more information, see [Multi-Region keys](https://docs.amazonaws.cn/kms/latest/developerguide/multi-region-keys-overview.html) in the *Amazon Key Management Service Developer Guide*. To replicate this primary key into a different Amazon Web Services Region, use the [AWS::KMS::ReplicaKey](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replica-key.html) CloudFormation resource. #### JSON ``` "myPrimaryKey": { "Type": "AWS::KMS::Key", "Properties": { "Description": "An example multi-Region primary key", "MultiRegion": true, "EnableKeyRotation": true, "PendingWindowInDays": 10, "KeyPolicy": { "Version": "2012-10-17", "Id": "key-default-1", "Statement": [ { "Sid": "Enable IAM User Permissions", "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::111122223333:root" }, "Action": "kms:*", "Resource": "*" }, { "Sid": "Allow administration of the key", "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::111122223333:user/Alice" }, "Action": [ "kms:ReplicateKey", "kms:Create*", "kms:Describe*", "kms:Enable*", "kms:List*", "kms:Put*", "kms:Update*", "kms:Revoke*", "kms:Disable*", "kms:Get*", "kms:Delete*", "kms:ScheduleKeyDeletion", "kms:CancelKeyDeletion" ], "Resource": "*" }, { "Sid": "Allow use of the key", "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::111122223333:user/Bob" }, "Action": [ "kms:DescribeKey", "kms:Encrypt", "kms:Decrypt", "kms:ReEncrypt*", "kms:GenerateDataKey", "kms:GenerateDataKeyWithoutPlaintext" ], "Resource": "*" } ] } } } ``` #### YAML ``` myPrimaryKey: Type: 'AWS::KMS::Key' Properties: Description: An example multi-Region primary key MultiRegion: true EnableKeyRotation: true PendingWindowInDays: 10 KeyPolicy: Version: 2012-10-17 Id: key-default-1 Statement: - Sid: Enable IAM User Permissions Effect: Allow Principal: AWS: 'arn:aws:iam::111122223333:root' Action: 'kms:*' Resource: '*' - Sid: Allow administration of the key Effect: Allow Principal: AWS: 'arn:aws:iam::111122223333:user/Alice' Action: - 'kms:ReplicateKey' - 'kms:Create*' - 'kms:Describe*' - 'kms:Enable*' - 'kms:List*' - 'kms:Put*' - 'kms:Update*' - 'kms:Revoke*' - 'kms:Disable*' - 'kms:Get*' - 'kms:Delete*' - 'kms:ScheduleKeyDeletion' - 'kms:CancelKeyDeletion' Resource: '*' - Sid: Allow use of the key Effect: Allow Principal: AWS: 'arn:aws:iam::111122223333:user/Bob' Action: - 'kms:DescribeKey' - 'kms:Encrypt' - 'kms:Decrypt' - 'kms:ReEncrypt*' - 'kms:GenerateDataKey' - 'kms:GenerateDataKeyWithoutPlaintext' Resource: '*' ``` ## See also + [Amazon KMS keys](https://docs.amazonaws.cn/kms/latest/developerguide/concepts.html#kms_keys) in the *Amazon Key Management Service Developer Guide*. + [CreateKey](https://docs.amazonaws.cn/kms/latest/APIReference/API_CreateKey.html) in the *Amazon Key Management Service API Reference*. + [Creating keys](https://docs.amazonaws.cn/kms/latest/developerguide/create-keys.html) in the *Amazon Key Management Service Developer Guide*. + [Creating asymmetric KMS keys](https://docs.amazonaws.cn/kms/latest/developerguide/asymm-create-key.html) in the *Amazon Key Management Service Developer Guide*. + [Creating HMAC KMS keys](https://docs.amazonaws.cn/kms/latest/developerguide/hmac-create-key.html) in the *Amazon Key Management Service Developer Guide*. + [Creating multi-Region primary keys](https://docs.amazonaws.cn/kms/latest/developerguide/create-primary-keys.html) in the *Amazon Key Management Service Developer Guide*.