@aws-cdk/aws-kms

  • Version 1.181.1
  • Published
  • 665 kB
  • 5 dependencies
  • Apache-2.0 license

Install

npm i @aws-cdk/aws-kms
yarn add @aws-cdk/aws-kms
pnpm add @aws-cdk/aws-kms

Overview

The CDK Construct Library for AWS::KMS

Index

Classes

class Alias

class Alias extends AliasBase {}
  • Defines a display name for a customer master key (CMK) in AWS Key Management Service (AWS KMS). Using an alias to refer to a key can help you simplify key management. For example, when rotating keys, you can just update the alias mapping instead of tracking and changing key IDs. For more information, see Working with Aliases in the AWS Key Management Service Developer Guide.

    You can also add an alias for a key by calling key.addAlias(alias).

    AWS::KMS::Alias

constructor

constructor(scope: Construct, id: string, props: AliasProps);

    property aliasName

    readonly aliasName: string;

      property aliasTargetKey

      readonly aliasTargetKey: IKey;

        method fromAliasAttributes

        static fromAliasAttributes: (
        scope: Construct,
        id: string,
        attrs: AliasAttributes
        ) => IAlias;
        • Import an existing KMS Alias defined outside the CDK app.

          Parameter scope

          The parent creating construct (usually this).

          Parameter id

          The construct's name.

          Parameter attrs

          the properties of the referenced KMS Alias

        method fromAliasName

        static fromAliasName: (
        scope: Construct,
        id: string,
        aliasName: string
        ) => IAlias;
        • Import an existing KMS Alias defined outside the CDK app, by the alias name. This method should be used instead of 'fromAliasAttributes' when the underlying KMS Key ARN is not available. This Alias will not have a direct reference to the KMS Key, so addAlias and grant* methods are not supported.

          Parameter scope

          The parent creating construct (usually this).

          Parameter id

          The construct's name.

          Parameter aliasName

          The full name of the KMS Alias (e.g., 'alias/aws/s3', 'alias/myKeyAlias').

        method generatePhysicalName

        protected generatePhysicalName: () => string;

          class CfnAlias

          class CfnAlias extends cdk.CfnResource implements cdk.IInspectable {}
          • A CloudFormation AWS::KMS::Alias

            The AWS::KMS::Alias resource specifies a display name for a [KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys) . You can use an alias to identify a KMS key in the AWS KMS console, in the [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html) operation, and in [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) , such as [Decrypt](https://docs.aws.amazon.com/kms/latest/APIReference/API_Decrypt.html) and [GenerateDataKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKey.html) .

            > Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see [ABAC for AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *AWS Key Management Service Developer Guide* .

            Using an alias to refer to a KMS key can help you simplify key management. For example, an alias in your code can be associated with different KMS keys in different AWS Regions . For more information, see [Using aliases](https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html) in the *AWS Key Management Service Developer Guide* .

            When specifying an alias, observe the following rules.

            - Each alias is associated with one KMS key, but multiple aliases can be associated with the same KMS key. - The alias and its associated KMS key must be in the same AWS account and Region. - The alias name must be unique in the AWS account and Region. However, you can create aliases with the same name in different AWS Regions . For example, you can have an alias/projectKey in multiple Regions, each of which is associated with a KMS key in its Region. - Each alias name must begin with alias/ followed by a name, such as alias/exampleKey . The alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). Alias names cannot begin with alias/aws/ . That alias name prefix is reserved for [AWS managed keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) .

            AWS::KMS::Alias external

            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-alias.html

          constructor

          constructor(scope: cdk.Construct, id: string, props: CfnAliasProps);
          • Create a new AWS::KMS::Alias.

            Parameter scope

            scope in which this resource is defined

            Parameter id

            scoped id of the resource

            Parameter props

            resource properties

          property aliasName

          aliasName: string;
          • Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias .

            > If you change the value of a Replacement property, such as AliasName , the existing alias is deleted and a new alias is created for the specified KMS key. This change can disrupt applications that use the alias. It can also allow or deny access to a KMS key affected by attribute-based access control (ABAC).

            The alias must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with alias/aws/ . The alias/aws/ prefix is reserved for [AWS managed keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) .

            *Pattern* : alias/^[a-zA-Z0-9/_-]+$

            *Minimum* : 1

            *Maximum* : 256

            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-alias.html#cfn-kms-alias-aliasname

          property CFN_RESOURCE_TYPE_NAME

          static readonly CFN_RESOURCE_TYPE_NAME: string;
          • The CloudFormation resource type name for this resource class.

          property cfnProperties

          readonly cfnProperties: { [key: string]: any };

            property targetKeyId

            targetKeyId: string;
            • Associates the alias with the specified [customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) . The KMS key must be in the same AWS account and Region.

              A valid key ID is required. If you supply a null or empty string value, this operation returns an error.

              For help finding the key ID and ARN, see [Finding the key ID and ARN](https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn) in the *AWS Key Management Service Developer Guide* .

              Specify the key ID or the key ARN of the KMS key.

              For example:

              - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab - Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

              To get the key ID and key ARN for a KMS key, use [ListKeys](https://docs.aws.amazon.com/kms/latest/APIReference/API_ListKeys.html) or [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html) .

              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-alias.html#cfn-kms-alias-targetkeyid

            method inspect

            inspect: (inspector: cdk.TreeInspector) => void;
            • Examines the CloudFormation resource and discloses attributes.

              Parameter inspector

              tree inspector to collect and process attributes

            method renderProperties

            protected renderProperties: (props: { [key: string]: any }) => {
            [key: string]: any;
            };

              class CfnKey

              class CfnKey extends cdk.CfnResource implements cdk.IInspectable {}
              • A CloudFormation AWS::KMS::Key

                The AWS::KMS::Key resource specifies an [KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys) in AWS 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.aws.amazon.com/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.

                You cannot use the AWS::KMS::Key resource to specify a KMS key with [imported key material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) or a KMS key in a [custom key store](https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) .

                > AWS KMS replaced the term *customer master key (CMK)* with *AWS KMS key* and *KMS key* . The concept has not changed. To prevent breaking changes, AWS 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 AWS KMS](https://docs.aws.amazon.com//kms/features/#AWS_Service_Integration) . For more information, see [Symmetric encryption KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#symmetric-cmks) in the *AWS 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 AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) in the *AWS 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 AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html) in the *AWS 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 AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *AWS Key Management Service Developer Guide* .

                > If you change the value of the KeyUsage , KeySpec , or MultiRegion property on an existing KMS key, the existing KMS key is [scheduled for deletion](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) and a new KMS key is created with the specified value. > > While scheduled for deletion, the existing KMS key becomes unusable. If you don't [cancel the scheduled deletion](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html#deleting-keys-scheduling-key-deletion) of the existing KMS key outside of CloudFormation, all data encrypted under the existing KMS key becomes unrecoverable when the KMS key is deleted.

                *Regions*

                AWS KMS CloudFormation resources are supported in all Regions in which AWS CloudFormation is supported. However, in the (ap-southeast-3), you cannot use a CloudFormation template to create or manage asymmetric KMS keys or multi-Region KMS keys (primary or replica).

                AWS::KMS::Key external

                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html

              constructor

              constructor(scope: cdk.Construct, id: string, props: CfnKeyProps);
              • Create a new AWS::KMS::Key.

                Parameter scope

                scope in which this resource is defined

                Parameter id

                scoped id of the resource

                Parameter props

                resource properties

              property attrArn

              readonly attrArn: 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](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN) in the *AWS Key Management Service Developer Guide* . Arn

              property attrKeyId

              readonly attrKeyId: 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](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id) in the *AWS Key Management Service Developer Guide* . KeyId

              property CFN_RESOURCE_TYPE_NAME

              static readonly CFN_RESOURCE_TYPE_NAME: string;
              • The CloudFormation resource type name for this resource class.

              property cfnProperties

              readonly cfnProperties: { [key: string]: any };

                property description

                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.

                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-description

                property enabled

                enabled: any;
                • 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.aws.amazon.com/kms/latest/APIReference/API_EnableKey.html) , [DisableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DisableKey.html) , or [ScheduleKeyDeletion](https://docs.aws.amazon.com/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.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *AWS Key Management Service Developer Guide* .

                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-enabled

                property enableKeyRotation

                enableKeyRotation: any;
                • Enables automatic rotation of the key material for the specified KMS key. By default, automatic key rotation is not enabled.

                  AWS KMS supports automatic rotation only for symmetric encryption KMS keys ( KeySpec = SYMMETRIC_DEFAULT ). For asymmetric KMS keys and HMAC KMS keys, 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 ). AWS KMS copies the rotation status to all replica keys. For details, see [Rotating multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate) in the *AWS Key Management Service Developer Guide* .

                  When you enable automatic rotation, AWS KMS automatically creates new key material for the KMS key one year after the enable date and every year thereafter. AWS KMS retains all key material until you delete the KMS key. For detailed information about automatic key rotation, see [Rotating KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) in the *AWS Key Management Service Developer Guide* .

                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-enablekeyrotation

                property keyPolicy

                keyPolicy: any;
                • The key policy that authorizes use of the KMS key. The key policy must conform to the following rules.

                  - The key policy must allow the caller to make a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) section of the **AWS Key Management Service Developer Guide** . - Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS 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 AWS KMS . For more information, see [Changes that I make are not always immediately visible](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) in the *AWS Identity and Access Management User Guide* .

                  If you are unsure of which policy to use, consider the *default key policy* . This is the key policy that AWS KMS applies to KMS keys that are created by using the CreateKey API with no specified key policy. It gives the AWS account that owns the key permission to perform all operations on the key. It also allows you write IAM policies to authorize access to the key. For details, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default) in the *AWS 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

                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-keypolicy

                property keySpec

                keySpec: string;
                • 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. 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.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose.html) in the *AWS 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 [AWS KMS condition keys](https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms) in the *AWS Key Management Service Developer Guide* .

                  > If you change the KeySpec value of an existing KMS key, the existing KMS key is scheduled for deletion and a new KMS key is created with the specified KeySpec value. While the scheduled deletion is pending, you can't use the existing KMS key. Unless you [cancel the scheduled deletion](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html#deleting-keys-scheduling-key-deletion) of the KMS key outside of CloudFormation, all data encrypted under the existing KMS key becomes unrecoverable when the KMS key is deleted. > [AWS services that are integrated with AWS KMS](https://docs.aws.amazon.com/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.aws.amazon.com/kms/latest/developerguide/find-symm-asymm.html) in the *AWS Key Management Service Developer Guide* .

                  AWS 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.

                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-keyspec

                property keyUsage

                keyUsage: string;
                • Determines the [cryptographic operations](https://docs.aws.amazon.com/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 KeyUsage value of an existing KMS key, the existing KMS key is scheduled for deletion and a new KMS key is created with the specified KeyUsage value. While the scheduled deletion is pending, you can't use the existing KMS key. Unless you [cancel the scheduled deletion](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html#deleting-keys-scheduling-key-deletion) of the KMS key outside of CloudFormation, all data encrypted under the existing KMS key becomes unrecoverable when the KMS key is deleted.

                  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 HMAC KMS keys, specify GENERATE_VERIFY_MAC .

                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-keyusage

                property multiRegion

                multiRegion: any;
                • 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.

                  > If you change the MultiRegion value of an existing KMS key, the existing KMS key is scheduled for deletion and a new KMS key is created with the specified Multi-Region value. While the scheduled deletion is pending, you can't use the existing KMS key. Unless you [cancel the scheduled deletion](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html#deleting-keys-scheduling-key-deletion) of the KMS key outside of CloudFormation, all data encrypted under the existing KMS key becomes unrecoverable when the KMS key is deleted.

                  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 AWS 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](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *AWS 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 AWS Region , create an [AWS::KMS::ReplicaKey](https://docs.aws.amazon.com/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.

                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-multiregion

                property pendingWindowInDays

                pendingWindowInDays: number;
                • Specifies the number of days in the waiting period before AWS 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, AWS 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, AWS KMS permanently deletes the KMS key.

                  AWS KMS will not delete a [multi-Region primary key](https://docs.aws.amazon.com/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, AWS KMS deletes the primary key. For details, see [Deleting multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *AWS 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 AWS KMS console or the [CancelKeyDeletion](https://docs.aws.amazon.com/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.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *AWS Key Management Service Developer Guide* . For more information about deleting KMS keys, see the [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operation in the *AWS Key Management Service API Reference* and [Deleting KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in the *AWS Key Management Service Developer Guide* .

                  *Minimum* : 7

                  *Maximum* : 30

                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-pendingwindowindays

                property tags

                readonly tags: cdk.TagManager;
                • 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 AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *AWS Key Management Service Developer Guide* .

                  For information about tags in AWS KMS , see [Tagging keys](https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html) in the *AWS Key Management Service Developer Guide* . For information about tags in CloudFormation, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .

                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-tags

                method inspect

                inspect: (inspector: cdk.TreeInspector) => void;
                • Examines the CloudFormation resource and discloses attributes.

                  Parameter inspector

                  tree inspector to collect and process attributes

                method renderProperties

                protected renderProperties: (props: { [key: string]: any }) => {
                [key: string]: any;
                };

                  class CfnReplicaKey

                  class CfnReplicaKey extends cdk.CfnResource implements cdk.IInspectable {}
                  • A CloudFormation AWS::KMS::ReplicaKey

                    The AWS::KMS::ReplicaKey resource specifies a multi-Region replica key that is based on a multi-Region primary key.

                    *Multi-Region keys* are an AWS 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](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *AWS Key Management Service Developer Guide* .

                    A multi-Region *primary key* is a fully functional symmetric encryption KMS key, HMAC KMS key, or asymmetric KMS key that is also the model for replica keys in other AWS Regions . To create a multi-Region primary key, add an [AWS::KMS::Key](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html) resource to your CloudFormation stack. Set its MultiRegion property to true.

                    A multi-Region *replica key* is a fully functional KMS key that has the same key ID and key material as a multi-Region primary key, but is located in a different AWS Region of the same AWS partition. There can be multiple replicas of a primary key, but each must be in a different AWS Region .

                    When you create a replica key in AWS CloudFormation , the replica key is created in the AWS Region represented by the endpoint you use for the request. If you try to replicate a multi-Region key into a Region in which the key type is not supported, the request will fail.

                    > HMAC KMS keys are not supported in all AWS Regions . For a list of supported Regions, see [HMAC keys in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html#hmac-regions) in the *AWS Key Management Service Developer Guide* .

                    A primary key and its replicas have the same key ID and key material. They also have the same key spec, key usage, key material origin, and automatic key rotation status. These properties are known as *shared properties* . If they change, AWS KMS synchronizes the change to all related multi-Region keys. All other properties of a replica key can differ, including its key policy, tags, aliases, and key state. AWS KMS does not synchronize these properties.

                    *Regions*

                    AWS KMS CloudFormation resources are supported in all Regions in which AWS CloudFormation is supported. However, in the (ap-southeast-3), you cannot use a CloudFormation template to create or manage multi-Region KMS keys (primary or replica).

                    AWS::KMS::ReplicaKey external

                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html

                  constructor

                  constructor(scope: cdk.Construct, id: string, props: CfnReplicaKeyProps);
                  • Create a new AWS::KMS::ReplicaKey.

                    Parameter scope

                    scope in which this resource is defined

                    Parameter id

                    scoped id of the resource

                    Parameter props

                    resource properties

                  property attrArn

                  readonly attrArn: string;
                  • The Amazon Resource Name (ARN) of the replica key, such as arn:aws:kms:us-west-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab .

                    The key ARNs of related multi-Region keys differ only in the Region value. For information about the key ARNs of multi-Region keys, see [How multi-Region keys work](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html#mrk-how-it-works) in the *AWS Key Management Service Developer Guide* . Arn

                  property attrKeyId

                  readonly attrKeyId: string;
                  • The key ID of the replica key, such as mrk-1234abcd12ab34cd56ef1234567890ab .

                    Related multi-Region keys have the same key ID. For information about the key IDs of multi-Region keys, see [How multi-Region keys work](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html#mrk-how-it-works) in the *AWS Key Management Service Developer Guide* . KeyId

                  property CFN_RESOURCE_TYPE_NAME

                  static readonly CFN_RESOURCE_TYPE_NAME: string;
                  • The CloudFormation resource type name for this resource class.

                  property cfnProperties

                  readonly cfnProperties: { [key: string]: any };

                    property description

                    description: string;
                    • A description of the KMS key.

                      The default value is an empty string (no description).

                      The description is not a shared property of multi-Region keys. You can specify the same description or a different description for each key in a set of related multi-Region keys. AWS Key Management Service does not synchronize this property.

                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html#cfn-kms-replicakey-description

                    property enabled

                    enabled: any;
                    • Specifies whether the replica 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 replica might be affected by actions taken outside of CloudFormation, such as running the [EnableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_EnableKey.html) , [DisableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DisableKey.html) , or [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operations. Also, while the replica key is being created, its key state is Creating . When the process is complete, the key state of the replica key changes to Enabled .

                      For information about the key states of a KMS key, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *AWS Key Management Service Developer Guide* .

                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html#cfn-kms-replicakey-enabled

                    property keyPolicy

                    keyPolicy: any;
                    • The key policy that authorizes use of the replica key.

                      The key policy is not a shared property of multi-Region keys. You can specify the same key policy or a different key policy for each key in a set of related multi-Region keys. AWS KMS does not synchronize this property.

                      The key policy must conform to the following rules.

                      - The key policy must give the caller [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) permission on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) section of the **AWS Key Management Service Developer Guide** . - Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS 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 AWS KMS . For more information, see [Changes that I make are not always immediately visible](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) in the *AWS Identity and Access Management User Guide* .

                      A key policy document can include only the following characters:

                      - Printable ASCII characters from the space character ( \ u0020 ) through the end of the ASCII character range. - Printable characters in the Basic Latin and Latin-1 Supplement character set (through \ u00FF ). - The tab ( \ u0009 ), line feed ( \ u000A ), and carriage return ( \ u000D ) special characters

                      *Minimum* : 1

                      *Maximum* : 32768

                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html#cfn-kms-replicakey-keypolicy

                    property pendingWindowInDays

                    pendingWindowInDays: number;
                    • Specifies the number of days in the waiting period before AWS KMS deletes a replica 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 replica key from a CloudFormation stack, AWS KMS schedules the replica 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 replica key is Pending Deletion , which prevents it from being used in cryptographic operations. When the waiting period expires, AWS KMS permanently deletes the replica key.

                      If the KMS key is a multi-Region primary key with replica keys, the waiting period begins when the last of its replica keys is deleted. Otherwise, the waiting period begins immediately.

                      You cannot use a CloudFormation template to cancel deletion of the replica after you remove it from the stack, regardless of the waiting period. However, if you specify a replica key in your template that is based on the same primary key as the original replica key, CloudFormation creates a new replica key with the same key ID, key material, and other shared properties of the original replica key. This new replica key can decrypt ciphertext that was encrypted under the original replica key, or any related multi-Region key.

                      For detailed information about deleting multi-Region keys, see [Deleting multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *AWS Key Management Service Developer Guide* .

                      For information about the PendingDeletion key state, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *AWS Key Management Service Developer Guide* . For more information about deleting KMS keys, see the [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operation in the *AWS Key Management Service API Reference* and [Deleting KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in the *AWS Key Management Service Developer Guide* .

                      *Minimum* : 7

                      *Maximum* : 30

                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html#cfn-kms-replicakey-pendingwindowindays

                    property primaryKeyArn

                    primaryKeyArn: string;
                    • Specifies the multi-Region primary key to replicate. The primary key must be in a different AWS Region of the same AWS partition. You can create only one replica of a given primary key in each AWS Region .

                      > If you change the PrimaryKeyArn value of a replica key, the existing replica key is scheduled for deletion and a new replica key is created based on the specified primary key. While it is scheduled for deletion, the existing replica key becomes unusable. You can cancel the scheduled deletion of the key outside of CloudFormation. > > However, if you inadvertently delete a replica key, you can decrypt ciphertext encrypted by that replica key by using any related multi-Region key. If necessary, you can recreate the replica in the same Region after the previous one is completely deleted. For details, see [Deleting multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *AWS Key Management Service Developer Guide*

                      Specify the key ARN of an existing multi-Region primary key. For example, arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab .

                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html#cfn-kms-replicakey-primarykeyarn

                    property tags

                    readonly tags: cdk.TagManager;
                    • 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 AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *AWS Key Management Service Developer Guide* .

                      Tags are not a shared property of multi-Region keys. You can specify the same tags or different tags for each key in a set of related multi-Region keys. AWS KMS does not synchronize this property.

                      Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, AWS KMS replaces the current tag value with the specified one.

                      When you assign tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details, see [Tagging keys](https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html) .

                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html#cfn-kms-replicakey-tags

                    method inspect

                    inspect: (inspector: cdk.TreeInspector) => void;
                    • Examines the CloudFormation resource and discloses attributes.

                      Parameter inspector

                      tree inspector to collect and process attributes

                    method renderProperties

                    protected renderProperties: (props: { [key: string]: any }) => {
                    [key: string]: any;
                    };

                      class Key

                      class Key extends KeyBase {}
                      • Defines a KMS key.

                        AWS::KMS::Key

                      constructor

                      constructor(scope: Construct, id: string, props?: KeyProps);

                        property keyArn

                        readonly keyArn: string;

                          property keyId

                          readonly keyId: string;

                            property policy

                            protected readonly policy?: iam.PolicyDocument;

                              property trustAccountIdentities

                              protected readonly trustAccountIdentities: boolean;

                                method fromCfnKey

                                static fromCfnKey: (cfnKey: CfnKey) => IKey;
                                • Create a mutable IKey based on a low-level CfnKey. This is most useful when combined with the cloudformation-include module. This method is different than because the IKey returned from this method is mutable; meaning, calling any mutating methods on it, like , will actually be reflected in the resulting template, as opposed to the object returned from , on which calling those methods would have no effect.

                                method fromKeyArn

                                static fromKeyArn: (scope: Construct, id: string, keyArn: string) => IKey;
                                • Import an externally defined KMS Key using its ARN.

                                  Parameter scope

                                  the construct that will "own" the imported key.

                                  Parameter id

                                  the id of the imported key in the construct tree.

                                  Parameter keyArn

                                  the ARN of an existing KMS key.

                                method fromLookup

                                static fromLookup: (
                                scope: Construct,
                                id: string,
                                options: KeyLookupOptions
                                ) => IKey;
                                • Import an existing Key by querying the AWS environment this stack is deployed to.

                                  This function only needs to be used to use Keys not defined in your CDK application. If you are looking to share a Key between stacks, you can pass the Key object between stacks and use it as normal. In addition, it's not necessary to use this method if an interface accepts an IKey. In this case, Alias.fromAliasName() can be used which returns an alias that extends IKey.

                                  Calling this method will lead to a lookup when the CDK CLI is executed. You can therefore not use any values that will only be available at CloudFormation execution time (i.e., Tokens).

                                  The Key information will be cached in cdk.context.json and the same Key will be used on future runs. To refresh the lookup, you will have to evict the value from the cache using the cdk context command. See https://docs.aws.amazon.com/cdk/latest/guide/context.html for more information.

                                method grantAdmin

                                grantAdmin: (grantee: iam.IGrantable) => iam.Grant;
                                • Grant admins permissions using this key to the given principal

                                  Key administrators have permissions to manage the key (e.g., change permissions, revoke), but do not have permissions to use the key in cryptographic operations (e.g., encrypt, decrypt).

                                class ViaServicePrincipal

                                class ViaServicePrincipal extends iam.PrincipalBase {}
                                • A principal to allow access to a key if it's being used through another AWS service

                                constructor

                                constructor(serviceName: string, basePrincipal?: iam.IPrincipal);

                                  property policyFragment

                                  readonly policyFragment: iam.PrincipalPolicyFragment;

                                    method dedupeString

                                    dedupeString: () => string | undefined;

                                      Interfaces

                                      interface AliasAttributes

                                      interface AliasAttributes {}
                                      • Properties of a reference to an existing KMS Alias

                                      property aliasName

                                      readonly aliasName: string;
                                      • Specifies the alias name. This value must begin with alias/ followed by a name (i.e. alias/ExampleAlias)

                                      property aliasTargetKey

                                      readonly aliasTargetKey: IKey;
                                      • The customer master key (CMK) to which the Alias refers.

                                      interface AliasProps

                                      interface AliasProps {}
                                      • Construction properties for a KMS Key Alias object.

                                      property aliasName

                                      readonly aliasName: string;
                                      • The name of the alias. The name must start with alias followed by a forward slash, such as alias/. You can't specify aliases that begin with alias/AWS. These aliases are reserved.

                                      property removalPolicy

                                      readonly removalPolicy?: RemovalPolicy;
                                      • Policy to apply when the alias is removed from this stack.

                                        - The alias will be deleted

                                      property targetKey

                                      readonly targetKey: IKey;
                                      • The ID of the key for which you are creating the alias. Specify the key's globally unique identifier or Amazon Resource Name (ARN). You can't specify another alias.

                                      interface CfnAliasProps

                                      interface CfnAliasProps {}
                                      • Properties for defining a CfnAlias

                                        external

                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-alias.html

                                      property aliasName

                                      readonly aliasName: string;
                                      • Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias .

                                        > If you change the value of a Replacement property, such as AliasName , the existing alias is deleted and a new alias is created for the specified KMS key. This change can disrupt applications that use the alias. It can also allow or deny access to a KMS key affected by attribute-based access control (ABAC).

                                        The alias must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with alias/aws/ . The alias/aws/ prefix is reserved for [AWS managed keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) .

                                        *Pattern* : alias/^[a-zA-Z0-9/_-]+$

                                        *Minimum* : 1

                                        *Maximum* : 256

                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-alias.html#cfn-kms-alias-aliasname

                                      property targetKeyId

                                      readonly targetKeyId: string;
                                      • Associates the alias with the specified [customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) . The KMS key must be in the same AWS account and Region.

                                        A valid key ID is required. If you supply a null or empty string value, this operation returns an error.

                                        For help finding the key ID and ARN, see [Finding the key ID and ARN](https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn) in the *AWS Key Management Service Developer Guide* .

                                        Specify the key ID or the key ARN of the KMS key.

                                        For example:

                                        - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab - Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

                                        To get the key ID and key ARN for a KMS key, use [ListKeys](https://docs.aws.amazon.com/kms/latest/APIReference/API_ListKeys.html) or [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html) .

                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-alias.html#cfn-kms-alias-targetkeyid

                                      interface CfnKeyProps

                                      interface CfnKeyProps {}
                                      • Properties for defining a CfnKey

                                        external

                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html

                                      property description

                                      readonly 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.

                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-description

                                      property enabled

                                      readonly enabled?: boolean | cdk.IResolvable;
                                      • 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.aws.amazon.com/kms/latest/APIReference/API_EnableKey.html) , [DisableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DisableKey.html) , or [ScheduleKeyDeletion](https://docs.aws.amazon.com/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.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *AWS Key Management Service Developer Guide* .

                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-enabled

                                      property enableKeyRotation

                                      readonly enableKeyRotation?: boolean | cdk.IResolvable;
                                      • Enables automatic rotation of the key material for the specified KMS key. By default, automatic key rotation is not enabled.

                                        AWS KMS supports automatic rotation only for symmetric encryption KMS keys ( KeySpec = SYMMETRIC_DEFAULT ). For asymmetric KMS keys and HMAC KMS keys, 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 ). AWS KMS copies the rotation status to all replica keys. For details, see [Rotating multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate) in the *AWS Key Management Service Developer Guide* .

                                        When you enable automatic rotation, AWS KMS automatically creates new key material for the KMS key one year after the enable date and every year thereafter. AWS KMS retains all key material until you delete the KMS key. For detailed information about automatic key rotation, see [Rotating KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) in the *AWS Key Management Service Developer Guide* .

                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-enablekeyrotation

                                      property keyPolicy

                                      readonly keyPolicy: any | cdk.IResolvable;
                                      • The key policy that authorizes use of the KMS key. The key policy must conform to the following rules.

                                        - The key policy must allow the caller to make a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) section of the **AWS Key Management Service Developer Guide** . - Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS 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 AWS KMS . For more information, see [Changes that I make are not always immediately visible](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) in the *AWS Identity and Access Management User Guide* .

                                        If you are unsure of which policy to use, consider the *default key policy* . This is the key policy that AWS KMS applies to KMS keys that are created by using the CreateKey API with no specified key policy. It gives the AWS account that owns the key permission to perform all operations on the key. It also allows you write IAM policies to authorize access to the key. For details, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default) in the *AWS 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

                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-keypolicy

                                      property keySpec

                                      readonly keySpec?: string;
                                      • 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. 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.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose.html) in the *AWS 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 [AWS KMS condition keys](https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms) in the *AWS Key Management Service Developer Guide* .

                                        > If you change the KeySpec value of an existing KMS key, the existing KMS key is scheduled for deletion and a new KMS key is created with the specified KeySpec value. While the scheduled deletion is pending, you can't use the existing KMS key. Unless you [cancel the scheduled deletion](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html#deleting-keys-scheduling-key-deletion) of the KMS key outside of CloudFormation, all data encrypted under the existing KMS key becomes unrecoverable when the KMS key is deleted. > [AWS services that are integrated with AWS KMS](https://docs.aws.amazon.com/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.aws.amazon.com/kms/latest/developerguide/find-symm-asymm.html) in the *AWS Key Management Service Developer Guide* .

                                        AWS 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.

                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-keyspec

                                      property keyUsage

                                      readonly keyUsage?: string;
                                      • Determines the [cryptographic operations](https://docs.aws.amazon.com/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 KeyUsage value of an existing KMS key, the existing KMS key is scheduled for deletion and a new KMS key is created with the specified KeyUsage value. While the scheduled deletion is pending, you can't use the existing KMS key. Unless you [cancel the scheduled deletion](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html#deleting-keys-scheduling-key-deletion) of the KMS key outside of CloudFormation, all data encrypted under the existing KMS key becomes unrecoverable when the KMS key is deleted.

                                        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 HMAC KMS keys, specify GENERATE_VERIFY_MAC .

                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-keyusage

                                      property multiRegion

                                      readonly multiRegion?: boolean | cdk.IResolvable;
                                      • 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.

                                        > If you change the MultiRegion value of an existing KMS key, the existing KMS key is scheduled for deletion and a new KMS key is created with the specified Multi-Region value. While the scheduled deletion is pending, you can't use the existing KMS key. Unless you [cancel the scheduled deletion](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html#deleting-keys-scheduling-key-deletion) of the KMS key outside of CloudFormation, all data encrypted under the existing KMS key becomes unrecoverable when the KMS key is deleted.

                                        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 AWS 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](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *AWS 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 AWS Region , create an [AWS::KMS::ReplicaKey](https://docs.aws.amazon.com/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.

                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-multiregion

                                      property pendingWindowInDays

                                      readonly pendingWindowInDays?: number;
                                      • Specifies the number of days in the waiting period before AWS 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, AWS 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, AWS KMS permanently deletes the KMS key.

                                        AWS KMS will not delete a [multi-Region primary key](https://docs.aws.amazon.com/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, AWS KMS deletes the primary key. For details, see [Deleting multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *AWS 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 AWS KMS console or the [CancelKeyDeletion](https://docs.aws.amazon.com/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.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *AWS Key Management Service Developer Guide* . For more information about deleting KMS keys, see the [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operation in the *AWS Key Management Service API Reference* and [Deleting KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in the *AWS Key Management Service Developer Guide* .

                                        *Minimum* : 7

                                        *Maximum* : 30

                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-pendingwindowindays

                                      property tags

                                      readonly tags?: cdk.CfnTag[];
                                      • 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 AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *AWS Key Management Service Developer Guide* .

                                        For information about tags in AWS KMS , see [Tagging keys](https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html) in the *AWS Key Management Service Developer Guide* . For information about tags in CloudFormation, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .

                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-tags

                                      interface CfnReplicaKeyProps

                                      interface CfnReplicaKeyProps {}
                                      • Properties for defining a CfnReplicaKey

                                        external

                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html

                                      property description

                                      readonly description?: string;
                                      • A description of the KMS key.

                                        The default value is an empty string (no description).

                                        The description is not a shared property of multi-Region keys. You can specify the same description or a different description for each key in a set of related multi-Region keys. AWS Key Management Service does not synchronize this property.

                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html#cfn-kms-replicakey-description

                                      property enabled

                                      readonly enabled?: boolean | cdk.IResolvable;
                                      • Specifies whether the replica 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 replica might be affected by actions taken outside of CloudFormation, such as running the [EnableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_EnableKey.html) , [DisableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DisableKey.html) , or [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operations. Also, while the replica key is being created, its key state is Creating . When the process is complete, the key state of the replica key changes to Enabled .

                                        For information about the key states of a KMS key, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *AWS Key Management Service Developer Guide* .

                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html#cfn-kms-replicakey-enabled

                                      property keyPolicy

                                      readonly keyPolicy: any | cdk.IResolvable;
                                      • The key policy that authorizes use of the replica key.

                                        The key policy is not a shared property of multi-Region keys. You can specify the same key policy or a different key policy for each key in a set of related multi-Region keys. AWS KMS does not synchronize this property.

                                        The key policy must conform to the following rules.

                                        - The key policy must give the caller [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) permission on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) section of the **AWS Key Management Service Developer Guide** . - Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS 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 AWS KMS . For more information, see [Changes that I make are not always immediately visible](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) in the *AWS Identity and Access Management User Guide* .

                                        A key policy document can include only the following characters:

                                        - Printable ASCII characters from the space character ( \ u0020 ) through the end of the ASCII character range. - Printable characters in the Basic Latin and Latin-1 Supplement character set (through \ u00FF ). - The tab ( \ u0009 ), line feed ( \ u000A ), and carriage return ( \ u000D ) special characters

                                        *Minimum* : 1

                                        *Maximum* : 32768

                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html#cfn-kms-replicakey-keypolicy

                                      property pendingWindowInDays

                                      readonly pendingWindowInDays?: number;
                                      • Specifies the number of days in the waiting period before AWS KMS deletes a replica 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 replica key from a CloudFormation stack, AWS KMS schedules the replica 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 replica key is Pending Deletion , which prevents it from being used in cryptographic operations. When the waiting period expires, AWS KMS permanently deletes the replica key.

                                        If the KMS key is a multi-Region primary key with replica keys, the waiting period begins when the last of its replica keys is deleted. Otherwise, the waiting period begins immediately.

                                        You cannot use a CloudFormation template to cancel deletion of the replica after you remove it from the stack, regardless of the waiting period. However, if you specify a replica key in your template that is based on the same primary key as the original replica key, CloudFormation creates a new replica key with the same key ID, key material, and other shared properties of the original replica key. This new replica key can decrypt ciphertext that was encrypted under the original replica key, or any related multi-Region key.

                                        For detailed information about deleting multi-Region keys, see [Deleting multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *AWS Key Management Service Developer Guide* .

                                        For information about the PendingDeletion key state, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *AWS Key Management Service Developer Guide* . For more information about deleting KMS keys, see the [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operation in the *AWS Key Management Service API Reference* and [Deleting KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in the *AWS Key Management Service Developer Guide* .

                                        *Minimum* : 7

                                        *Maximum* : 30

                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html#cfn-kms-replicakey-pendingwindowindays

                                      property primaryKeyArn

                                      readonly primaryKeyArn: string;
                                      • Specifies the multi-Region primary key to replicate. The primary key must be in a different AWS Region of the same AWS partition. You can create only one replica of a given primary key in each AWS Region .

                                        > If you change the PrimaryKeyArn value of a replica key, the existing replica key is scheduled for deletion and a new replica key is created based on the specified primary key. While it is scheduled for deletion, the existing replica key becomes unusable. You can cancel the scheduled deletion of the key outside of CloudFormation. > > However, if you inadvertently delete a replica key, you can decrypt ciphertext encrypted by that replica key by using any related multi-Region key. If necessary, you can recreate the replica in the same Region after the previous one is completely deleted. For details, see [Deleting multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *AWS Key Management Service Developer Guide*

                                        Specify the key ARN of an existing multi-Region primary key. For example, arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab .

                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html#cfn-kms-replicakey-primarykeyarn

                                      property tags

                                      readonly tags?: cdk.CfnTag[];
                                      • 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 AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *AWS Key Management Service Developer Guide* .

                                        Tags are not a shared property of multi-Region keys. You can specify the same tags or different tags for each key in a set of related multi-Region keys. AWS KMS does not synchronize this property.

                                        Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, AWS KMS replaces the current tag value with the specified one.

                                        When you assign tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details, see [Tagging keys](https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html) .

                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html#cfn-kms-replicakey-tags

                                      interface IAlias

                                      interface IAlias extends IKey {}
                                      • A KMS Key alias. An alias can be used in all places that expect a key.

                                      property aliasName

                                      readonly aliasName: string;
                                      • The name of the alias.

                                      property aliasTargetKey

                                      readonly aliasTargetKey: IKey;
                                      • The Key to which the Alias refers.

                                      interface IKey

                                      interface IKey extends IResource {}
                                      • A KMS Key, either managed by this CDK app, or imported.

                                      property keyArn

                                      readonly keyArn: string;
                                      • The ARN of the key.

                                      property keyId

                                      readonly keyId: string;
                                      • The ID of the key (the part that looks something like: 1234abcd-12ab-34cd-56ef-1234567890ab).

                                      method addAlias

                                      addAlias: (alias: string) => Alias;
                                      • Defines a new alias for the key.

                                      method addToResourcePolicy

                                      addToResourcePolicy: (
                                      statement: iam.PolicyStatement,
                                      allowNoOp?: boolean
                                      ) => iam.AddToResourcePolicyResult;
                                      • Adds a statement to the KMS key resource policy.

                                        Parameter statement

                                        The policy statement to add

                                        Parameter allowNoOp

                                        If this is set to false and there is no policy defined (i.e. external key), the operation will fail. Otherwise, it will no-op.

                                      method grant

                                      grant: (grantee: iam.IGrantable, ...actions: string[]) => iam.Grant;
                                      • Grant the indicated permissions on this key to the given principal

                                      method grantDecrypt

                                      grantDecrypt: (grantee: iam.IGrantable) => iam.Grant;
                                      • Grant decryption permissions using this key to the given principal

                                      method grantEncrypt

                                      grantEncrypt: (grantee: iam.IGrantable) => iam.Grant;
                                      • Grant encryption permissions using this key to the given principal

                                      method grantEncryptDecrypt

                                      grantEncryptDecrypt: (grantee: iam.IGrantable) => iam.Grant;
                                      • Grant encryption and decryption permissions using this key to the given principal

                                      interface KeyLookupOptions

                                      interface KeyLookupOptions {}
                                      • Properties for looking up an existing Key.

                                      property aliasName

                                      readonly aliasName: string;
                                      • The alias name of the Key

                                      interface KeyProps

                                      interface KeyProps {}
                                      • Construction properties for a KMS Key object

                                      property admins

                                      readonly admins?: iam.IPrincipal[];
                                      • A list of principals to add as key administrators to the key policy.

                                        Key administrators have permissions to manage the key (e.g., change permissions, revoke), but do not have permissions to use the key in cryptographic operations (e.g., encrypt, decrypt).

                                        These principals will be added to the default key policy (if none specified), or to the specified policy (if provided).

                                        []

                                      property alias

                                      readonly alias?: string;
                                      • Initial alias to add to the key

                                        More aliases can be added later by calling addAlias.

                                        - No alias is added for the key.

                                      property description

                                      readonly description?: string;
                                      • A description of the key. Use a description that helps your users decide whether the key is appropriate for a particular task.

                                        - No description.

                                      property enabled

                                      readonly enabled?: boolean;
                                      • Indicates whether the key is available for use.

                                        - Key is enabled.

                                      property enableKeyRotation

                                      readonly enableKeyRotation?: boolean;
                                      • Indicates whether AWS KMS rotates the key.

                                        false

                                      property keySpec

                                      readonly keySpec?: KeySpec;
                                      • The cryptographic configuration of the key. The valid value depends on usage of the key.

                                        IMPORTANT: If you change this property of an existing key, the existing key is scheduled for deletion and a new key is created with the specified value.

                                        KeySpec.SYMMETRIC_DEFAULT

                                      property keyUsage

                                      readonly keyUsage?: KeyUsage;
                                      • The cryptographic operations for which the key can be used.

                                        IMPORTANT: If you change this property of an existing key, the existing key is scheduled for deletion and a new key is created with the specified value.

                                        KeyUsage.ENCRYPT_DECRYPT

                                      property pendingWindow

                                      readonly pendingWindow?: Duration;
                                      • Specifies the number of days in the waiting period before AWS KMS deletes a CMK that has been removed from a CloudFormation stack.

                                        When you remove a customer master key (CMK) from a CloudFormation stack, AWS KMS schedules the CMK 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 CMK is Pending Deletion, which prevents the CMK from being used in cryptographic operations. When the waiting period expires, AWS KMS permanently deletes the CMK.

                                        Enter a value between 7 and 30 days.

                                        See Also

                                        • https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-pendingwindowindays - 30 days

                                      property policy

                                      readonly policy?: iam.PolicyDocument;
                                      • Custom policy document to attach to the KMS key.

                                        NOTE - If the @aws-cdk/aws-kms:defaultKeyPolicies feature flag is set (the default for new projects), this policy will *override* the default key policy and become the only key policy for the key. If the feature flag is not set, this policy will be appended to the default key policy.

                                        - A policy document with permissions for the account root to administer the key will be created.

                                      property removalPolicy

                                      readonly removalPolicy?: RemovalPolicy;
                                      • Whether the encryption key should be retained when it is removed from the Stack. This is useful when one wants to retain access to data that was encrypted with a key that is being retired.

                                        RemovalPolicy.Retain

                                      property trustAccountIdentities

                                      readonly trustAccountIdentities?: boolean;
                                      • Whether the key usage can be granted by IAM policies

                                        Setting this to true adds a default statement which delegates key access control completely to the identity's IAM policy (similar to how it works for other AWS resources). This matches the default behavior when creating KMS keys via the API or console.

                                        If the @aws-cdk/aws-kms:defaultKeyPolicies feature flag is set (the default for new projects), this flag will always be treated as 'true' and does not need to be explicitly set.

                                        - false, unless the @aws-cdk/aws-kms:defaultKeyPolicies feature flag is set.

                                        See Also

                                        • https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam

                                        Deprecated

                                        redundant with the @aws-cdk/aws-kms:defaultKeyPolicies feature flag

                                      Enums

                                      enum KeySpec

                                      enum KeySpec {
                                      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',
                                      }
                                      • The key spec, represents the cryptographic configuration of keys.

                                      member ECC_NIST_P256

                                      ECC_NIST_P256 = 'ECC_NIST_P256'
                                      • NIST FIPS 186-4, Section 6.4, ECDSA signature using the curve specified by the key and SHA-256 for the message digest.

                                        Valid usage: SIGN_VERIFY

                                      member ECC_NIST_P384

                                      ECC_NIST_P384 = 'ECC_NIST_P384'
                                      • NIST FIPS 186-4, Section 6.4, ECDSA signature using the curve specified by the key and SHA-384 for the message digest.

                                        Valid usage: SIGN_VERIFY

                                      member ECC_NIST_P521

                                      ECC_NIST_P521 = 'ECC_NIST_P521'
                                      • NIST FIPS 186-4, Section 6.4, ECDSA signature using the curve specified by the key and SHA-512 for the message digest.

                                        Valid usage: SIGN_VERIFY

                                      member ECC_SECG_P256K1

                                      ECC_SECG_P256K1 = 'ECC_SECG_P256K1'
                                      • Standards for Efficient Cryptography 2, Section 2.4.1, ECDSA signature on the Koblitz curve.

                                        Valid usage: SIGN_VERIFY

                                      member RSA_2048

                                      RSA_2048 = 'RSA_2048'
                                      • RSA with 2048 bits of key.

                                        Valid usage: ENCRYPT_DECRYPT and SIGN_VERIFY

                                      member RSA_3072

                                      RSA_3072 = 'RSA_3072'
                                      • RSA with 3072 bits of key.

                                        Valid usage: ENCRYPT_DECRYPT and SIGN_VERIFY

                                      member RSA_4096

                                      RSA_4096 = 'RSA_4096'
                                      • RSA with 4096 bits of key.

                                        Valid usage: ENCRYPT_DECRYPT and SIGN_VERIFY

                                      member SYMMETRIC_DEFAULT

                                      SYMMETRIC_DEFAULT = 'SYMMETRIC_DEFAULT'
                                      • The default key spec.

                                        Valid usage: ENCRYPT_DECRYPT

                                      enum KeyUsage

                                      enum KeyUsage {
                                      ENCRYPT_DECRYPT = 'ENCRYPT_DECRYPT',
                                      SIGN_VERIFY = 'SIGN_VERIFY',
                                      }
                                      • The key usage, represents the cryptographic operations of keys.

                                      member ENCRYPT_DECRYPT

                                      ENCRYPT_DECRYPT = 'ENCRYPT_DECRYPT'
                                      • Encryption and decryption.

                                      member SIGN_VERIFY

                                      SIGN_VERIFY = 'SIGN_VERIFY'
                                      • Signing and verification

                                      Package Files (6)

                                      Dependencies (5)

                                      Dev Dependencies (7)

                                      Peer Dependencies (5)

                                      Badge

                                      To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                      You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@aws-cdk/aws-kms.

                                      • Markdown
                                        [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@aws-cdk/aws-kms)
                                      • HTML
                                        <a href="https://www.jsdocs.io/package/@aws-cdk/aws-kms"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>