Skip to content
This repository was archived by the owner on Dec 10, 2025. It is now read-only.

kmsKey.md

Latest commit

 

History

History
1289 lines (804 loc) · 47.9 KB

kmsKey.md

File metadata and controls

1289 lines (804 loc) · 47.9 KB
Raw

kmsKey Submodule

Constructs

KmsKey

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/kms_key aws_kms_key}.

Initializers 

import { kmsKey } from '@cdktf/aws-cdk'

new kmsKey.KmsKey(scope: Construct, id: string, config?: KmsKeyConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config KmsKeyConfig No description.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

configOptional

Methods

Name Description
toString Returns a string representation of this construct.
addOverride No description.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform No description.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
addMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
hasResourceMove No description.
importFrom No description.
interpolationForAttribute No description.
moveFromId Move the resource corresponding to "id" to this resource.
moveTo Moves this resource to the target resource given by moveTarget.
moveToId Moves this resource to the resource corresponding to "id".
resetBypassPolicyLockoutSafetyCheck No description.
resetCustomerMasterKeySpec No description.
resetDeletionWindowInDays No description.
resetDescription No description.
resetEnableKeyRotation No description.
resetId No description.
resetIsEnabled No description.
resetKeyUsage No description.
resetMultiRegion No description.
resetPolicy No description.
resetTags No description.
resetTagsAll No description.
toString 
public toString(): string

Returns a string representation of this construct.

addOverride 
public addOverride(path: string, value: any): void
pathRequired
  • Type: string
valueRequired
  • Type: any
overrideLogicalId 
public overrideLogicalId(newLogicalId: string): void

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public resetOverrideLogicalId(): void

Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform 
public toHclTerraform(): any
toMetadata 
public toMetadata(): any
toTerraform 
public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget 
public addMoveTarget(moveTarget: string): void

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTargetRequired
  • Type: string

The string move target that will correspond to this resource.

getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
hasResourceMove 
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom 
public importFrom(id: string, provider?: TerraformProvider): void
idRequired
  • Type: string
providerOptional
  • Type: cdktf.TerraformProvider
interpolationForAttribute 
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
moveFromId 
public moveFromId(id: string): void

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

moveTo 
public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

indexOptional
  • Type: string | number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

moveToId 
public moveToId(id: string): void

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

resetBypassPolicyLockoutSafetyCheck 
public resetBypassPolicyLockoutSafetyCheck(): void
resetCustomerMasterKeySpec 
public resetCustomerMasterKeySpec(): void
resetDeletionWindowInDays 
public resetDeletionWindowInDays(): void
resetDescription 
public resetDescription(): void
resetEnableKeyRotation 
public resetEnableKeyRotation(): void
resetId 
public resetId(): void
resetIsEnabled 
public resetIsEnabled(): void
resetKeyUsage 
public resetKeyUsage(): void
resetMultiRegion 
public resetMultiRegion(): void
resetPolicy 
public resetPolicy(): void
resetTags 
public resetTags(): void
resetTagsAll 
public resetTagsAll(): void

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTF code for importing a KmsKey resource upon running "cdktf plan ".
isConstruct 
import { kmsKey } from '@cdktf/aws-cdk'

kmsKey.KmsKey.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: any

Any object.

isTerraformElement 
import { kmsKey } from '@cdktf/aws-cdk'

kmsKey.KmsKey.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformResource 
import { kmsKey } from '@cdktf/aws-cdk'

kmsKey.KmsKey.isTerraformResource(x: any)
xRequired
  • Type: any
generateConfigForImport 
import { kmsKey } from '@cdktf/aws-cdk'

kmsKey.KmsKey.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a KmsKey resource upon running "cdktf plan ".

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: string

The construct id used in the generated config for the KmsKey to import.

importFromIdRequired
  • Type: string

The id of the existing KmsKey that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/kms_key#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: cdktf.TerraformProvider

? Optional instance of the provider where the KmsKey to import is found.

Properties

Name Type Description
node constructs.Node The tree node.
cdktfStack cdktf.TerraformStack No description.
fqn string No description.
friendlyUniqueId string No description.
terraformMetaArguments {[ key: string ]: any} No description.
terraformResourceType string No description.
terraformGeneratorMetadata cdktf.TerraformProviderGeneratorMetadata No description.
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn string[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
arn string No description.
keyId string No description.
bypassPolicyLockoutSafetyCheckInput boolean | cdktf.IResolvable No description.
customerMasterKeySpecInput string No description.
deletionWindowInDaysInput number No description.
descriptionInput string No description.
enableKeyRotationInput boolean | cdktf.IResolvable No description.
idInput string No description.
isEnabledInput boolean | cdktf.IResolvable No description.
keyUsageInput string No description.
multiRegionInput boolean | cdktf.IResolvable No description.
policyInput string No description.
tagsAllInput {[ key: string ]: string} No description.
tagsInput {[ key: string ]: string} No description.
bypassPolicyLockoutSafetyCheck boolean | cdktf.IResolvable No description.
customerMasterKeySpec string No description.
deletionWindowInDays number No description.
description string No description.
enableKeyRotation boolean | cdktf.IResolvable No description.
id string No description.
isEnabled boolean | cdktf.IResolvable No description.
keyUsage string No description.
multiRegion boolean | cdktf.IResolvable No description.
policy string No description.
tags {[ key: string ]: string} No description.
tagsAll {[ key: string ]: string} No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

cdktfStackRequired 
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack
fqnRequired 
public readonly fqn: string;
  • Type: string
friendlyUniqueIdRequired 
public readonly friendlyUniqueId: string;
  • Type: string
terraformMetaArgumentsRequired 
public readonly terraformMetaArguments: {[ key: string ]: any};
  • Type: {[ key: string ]: any}
terraformResourceTypeRequired 
public readonly terraformResourceType: string;
  • Type: string
terraformGeneratorMetadataOptional 
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: string[];
  • Type: string[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
arnRequired 
public readonly arn: string;
  • Type: string
keyIdRequired 
public readonly keyId: string;
  • Type: string
bypassPolicyLockoutSafetyCheckInputOptional 
public readonly bypassPolicyLockoutSafetyCheckInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
customerMasterKeySpecInputOptional 
public readonly customerMasterKeySpecInput: string;
  • Type: string
deletionWindowInDaysInputOptional 
public readonly deletionWindowInDaysInput: number;
  • Type: number
descriptionInputOptional 
public readonly descriptionInput: string;
  • Type: string
enableKeyRotationInputOptional 
public readonly enableKeyRotationInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
idInputOptional 
public readonly idInput: string;
  • Type: string
isEnabledInputOptional 
public readonly isEnabledInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
keyUsageInputOptional 
public readonly keyUsageInput: string;
  • Type: string
multiRegionInputOptional 
public readonly multiRegionInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
policyInputOptional 
public readonly policyInput: string;
  • Type: string
tagsAllInputOptional 
public readonly tagsAllInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
tagsInputOptional 
public readonly tagsInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
bypassPolicyLockoutSafetyCheckRequired 
public readonly bypassPolicyLockoutSafetyCheck: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
customerMasterKeySpecRequired 
public readonly customerMasterKeySpec: string;
  • Type: string
deletionWindowInDaysRequired 
public readonly deletionWindowInDays: number;
  • Type: number
descriptionRequired 
public readonly description: string;
  • Type: string
enableKeyRotationRequired 
public readonly enableKeyRotation: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
idRequired 
public readonly id: string;
  • Type: string
isEnabledRequired 
public readonly isEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
keyUsageRequired 
public readonly keyUsage: string;
  • Type: string
multiRegionRequired 
public readonly multiRegion: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
policyRequired 
public readonly policy: string;
  • Type: string
tagsRequired 
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
tagsAllRequired 
public readonly tagsAll: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Constants

Name Type Description
tfResourceType string No description.
tfResourceTypeRequired 
public readonly tfResourceType: string;
  • Type: string

Structs

KmsKeyConfig

Initializer 

import { kmsKey } from '@cdktf/aws-cdk'

const kmsKeyConfig: kmsKey.KmsKeyConfig = { ... }

Properties

Name Type Description
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn cdktf.ITerraformDependable[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
bypassPolicyLockoutSafetyCheck boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/kms_key#bypass_policy_lockout_safety_check KmsKey#bypass_policy_lockout_safety_check}.
customerMasterKeySpec string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/kms_key#customer_master_key_spec KmsKey#customer_master_key_spec}.
deletionWindowInDays number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/kms_key#deletion_window_in_days KmsKey#deletion_window_in_days}.
description string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/kms_key#description KmsKey#description}.
enableKeyRotation boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/kms_key#enable_key_rotation KmsKey#enable_key_rotation}.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/kms_key#id KmsKey#id}.
isEnabled boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/kms_key#is_enabled KmsKey#is_enabled}.
keyUsage string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/kms_key#key_usage KmsKey#key_usage}.
multiRegion boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/kms_key#multi_region KmsKey#multi_region}.
policy string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/kms_key#policy KmsKey#policy}.
tags {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/kms_key#tags KmsKey#tags}.
tagsAll {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/kms_key#tags_all KmsKey#tags_all}.
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
bypassPolicyLockoutSafetyCheckOptional 
public readonly bypassPolicyLockoutSafetyCheck: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/kms_key#bypass_policy_lockout_safety_check KmsKey#bypass_policy_lockout_safety_check}.

customerMasterKeySpecOptional 
public readonly customerMasterKeySpec: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/kms_key#customer_master_key_spec KmsKey#customer_master_key_spec}.

deletionWindowInDaysOptional 
public readonly deletionWindowInDays: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/kms_key#deletion_window_in_days KmsKey#deletion_window_in_days}.

descriptionOptional 
public readonly description: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/kms_key#description KmsKey#description}.

enableKeyRotationOptional 
public readonly enableKeyRotation: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/kms_key#enable_key_rotation KmsKey#enable_key_rotation}.

idOptional 
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/kms_key#id KmsKey#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

isEnabledOptional 
public readonly isEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/kms_key#is_enabled KmsKey#is_enabled}.

keyUsageOptional 
public readonly keyUsage: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/kms_key#key_usage KmsKey#key_usage}.

multiRegionOptional 
public readonly multiRegion: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/kms_key#multi_region KmsKey#multi_region}.

policyOptional 
public readonly policy: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/kms_key#policy KmsKey#policy}.

tagsOptional 
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/kms_key#tags KmsKey#tags}.

tagsAllOptional 
public readonly tagsAll: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/kms_key#tags_all KmsKey#tags_all}.