class CfnKeyPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.KMS.Mixins.CfnKeyPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awskms/mixins#CfnKeyPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.kms.mixins.CfnKeyPropsMixin
Python	aws_cdk.mixins_preview.aws_kms.mixins.CfnKeyPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_kms » mixins » CfnKeyPropsMixin

Implements IMixin

Extends Mixin

The AWS::KMS::Key resource specifies an KMS key 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 of all supported types. To replicate a multi-Region key, use the AWS::KMS::ReplicaKey resource.

If you change the value of the KeySpec , KeyUsage , Origin , or MultiRegion properties of an existing KMS key, the update request fails, regardless of the value of the UpdateReplacePolicy attribute . This prevents you from accidentally deleting a KMS key by changing any of its immutable property values. > AWS replaced the term customer master key (CMK) with AWS KMS key and KMS key . The concept has not changed. To prevent breaking changes, AWS 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 . For more information, see Symmetric encryption KMS keys 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 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 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 in the AWS Key Management Service Developer Guide .

You cannot use the AWS::KMS::Key resource to specify a KMS key with imported key material or a KMS key in a custom key store .

Regions

AWS CloudFormation resources are available in all Regions in which AWS and CloudFormation are supported. You can use the AWS::KMS::Key resource to create and manage all KMS key types that are supported in a Region.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as kms_mixins } from '@aws-cdk/mixins-preview/aws-kms';

declare const keyPolicy: any;
const cfnKeyPropsMixin = new kms_mixins.CfnKeyPropsMixin({
  bypassPolicyLockoutSafetyCheck: false,
  description: 'description',
  enabled: false,
  enableKeyRotation: false,
  keyPolicy: keyPolicy,
  keySpec: 'keySpec',
  keyUsage: 'keyUsage',
  multiRegion: false,
  origin: 'origin',
  pendingWindowInDays: 123,
  rotationPeriodInDays: 123,
  tags: [{
    key: 'key',
    value: 'value',
  }],
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnKeyPropsMixin(props: CfnKeyMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnKeyMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::KMS::Key.

Properties

Name	Type	Description
props	CfnKeyMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnKeyMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.