Class KeyConfig

SecurityConfig / KeyManagementServiceConfig / KeyConfig

https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-mgmt | AWS KMS Key configuration. Use this configuration to define your customer managed key (CMK) and where it's deployed to along with it's management properties.

Example

- name: ExampleKey
  deploymentTargets:
    organizationalUnits:
      - Root
  alias: alias/example/key
  policy: path/to/policy.json
  description: Example KMS key
  enabled: true
  enableKeyRotation: true
  removalPolicy: retain

Hierarchy

  • KeyConfig

Implements

Constructors

constructor

Properties

alias deploymentTargets description enableKeyRotation enabled name policy removalPolicy

Constructors

constructor

Properties

Readonly alias

alias: "" = ''

(OPTIONAL) Initial alias to add to the key

Remarks

Note: If changing this value, a new CMK with the new alias will be created.

Readonly deploymentTargets

deploymentTargets: DeploymentTargets = ...

This configuration determines which accounts and/or OUs the CMK is deployed to.

To deploy KMS key into Root and Infrastructure organizational units, you need to provide below value for this parameter.

Example

- deploymentTargets:
        organizationalUnits:
          - Root
          - Infrastructure

Readonly description

description: "" = ''

(OPTIONAL) A description of the key.

Readonly enableKeyRotation

enableKeyRotation: true = true

(OPTIONAL) Indicates whether AWS KMS rotates the key.

Default

true

Readonly enabled

enabled: true = true

(OPTIONAL) Indicates whether the key is available for use.

Default

  • Key is enabled.

Readonly name

name: "" = ''

Unique Key name for logical reference

Readonly policy

policy: "" = ''

(OPTIONAL)Key policy file path. This file must be available in accelerator config repository.

Readonly removalPolicy

removalPolicy: "retain" = 'retain'

(OPTIONAL) Whether the encryption key should be retained when it is removed from the Stack.

Default

retain

Settings

Member Visibility

Theme

Generated using TypeDoc