Class KeyConfig

SecurityConfig / KeyManagementServiceConfig / KeyConfig

AWS KMS Key configuration

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: "" = ''

Initial alias to add to the key

Readonly deploymentTargets

deploymentTargets: DeploymentTargets = ...

KMS key deployment target.

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: "" = ''

A description of the key.

Readonly enableKeyRotation

enableKeyRotation: true = true

Indicates whether AWS KMS rotates the key.

Default

true

Readonly enabled

enabled: true = true

Indicates whether the key is available for use.

Default

  • Key is enabled.

Readonly name

name: "" = ''

Unique Key name for logical reference

Readonly policy

policy: "" = ''

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

Readonly removalPolicy

removalPolicy: "retain" = 'retain'

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

Default

retain

Settings

Member Visibility

Theme

Generated using TypeDoc