`kmsKey` Submodule

Constructs

KmsKey

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

Initializers

import "github.com/cdktf/cdktf-provider-aws-go/aws/v19/kmskey"

kmskey.NewKmsKey(scope Construct, id *string, config KmsKeyConfig) KmsKey

Name	Type	Description
`scope`	`github.com/aws/constructs-go/constructs/v10.Construct`	The scope in which to define this construct.
`id`	`*string`	The scoped construct ID.
`config`	`KmsKeyConfig`	No description.

`scope`^Required

Type: github.com/aws/constructs-go/constructs/v10.Construct

The scope in which to define this construct.

`id`^Required

Type: *string

The scoped construct ID.

Must be unique amongst siblings in the same scope

`config`^Optional

Type: KmsKeyConfig

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".
`PutTimeouts`	No description.
`ResetBypassPolicyLockoutSafetyCheck`	No description.
`ResetCustomerMasterKeySpec`	No description.
`ResetCustomKeyStoreId`	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.
`ResetRotationPeriodInDays`	No description.
`ResetTags`	No description.
`ResetTagsAll`	No description.
`ResetTimeouts`	No description.
`ResetXksKeyId`	No description.

`ToString`

func ToString() *string

Returns a string representation of this construct.

`AddOverride`

func AddOverride(path *string, value interface{})

`path`^Required

Type: *string

`value`^Required

Type: interface{}

`OverrideLogicalId`

func OverrideLogicalId(newLogicalId *string)

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

`newLogicalId`^Required

Type: *string

The new logical ID to use for this stack element.

`ResetOverrideLogicalId`

func ResetOverrideLogicalId()

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

`ToHclTerraform`

func ToHclTerraform() interface{}

`ToMetadata`

func ToMetadata() interface{}

`ToTerraform`

func ToTerraform() interface{}

Adds this resource to the terraform JSON output.

`AddMoveTarget`

func AddMoveTarget(moveTarget *string)

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

`moveTarget`^Required

Type: *string

The string move target that will correspond to this resource.

`GetAnyMapAttribute`

func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}

`terraformAttribute`^Required

Type: *string

`GetBooleanAttribute`

func GetBooleanAttribute(terraformAttribute *string) IResolvable

`terraformAttribute`^Required

Type: *string

`GetBooleanMapAttribute`

func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool

`terraformAttribute`^Required

Type: *string

`GetListAttribute`

func GetListAttribute(terraformAttribute *string) *[]*string

`terraformAttribute`^Required

Type: *string

`GetNumberAttribute`

func GetNumberAttribute(terraformAttribute *string) *f64

`terraformAttribute`^Required

Type: *string

`GetNumberListAttribute`

func GetNumberListAttribute(terraformAttribute *string) *[]*f64

`terraformAttribute`^Required

Type: *string

`GetNumberMapAttribute`

func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64

`terraformAttribute`^Required

Type: *string

`GetStringAttribute`

func GetStringAttribute(terraformAttribute *string) *string

`terraformAttribute`^Required

Type: *string

`GetStringMapAttribute`

func GetStringMapAttribute(terraformAttribute *string) *map[string]*string

`terraformAttribute`^Required

Type: *string

`HasResourceMove`

func HasResourceMove() interface{}

`ImportFrom`

func ImportFrom(id *string, provider TerraformProvider)

`id`^Required

Type: *string

`provider`^Optional

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

`InterpolationForAttribute`

func InterpolationForAttribute(terraformAttribute *string) IResolvable

`terraformAttribute`^Required

Type: *string

`MoveFromId`

func MoveFromId(id *string)

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.

`id`^Required

Type: *string

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

`MoveTo`

func MoveTo(moveTarget *string, index interface{})

Moves this resource to the target resource given by moveTarget.

`moveTarget`^Required

Type: *string

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

`index`^Optional

Type: interface{}

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

`MoveToId`

func MoveToId(id *string)

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

`id`^Required

Type: *string

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

`PutTimeouts`

func PutTimeouts(value KmsKeyTimeouts)

`value`^Required

Type: KmsKeyTimeouts

`ResetBypassPolicyLockoutSafetyCheck`

func ResetBypassPolicyLockoutSafetyCheck()

`ResetCustomerMasterKeySpec`

func ResetCustomerMasterKeySpec()

`ResetCustomKeyStoreId`

func ResetCustomKeyStoreId()

`ResetDeletionWindowInDays`

func ResetDeletionWindowInDays()

`ResetDescription`

func ResetDescription()

`ResetEnableKeyRotation`

func ResetEnableKeyRotation()

`ResetId`

func ResetId()

`ResetIsEnabled`

func ResetIsEnabled()

`ResetKeyUsage`

func ResetKeyUsage()

`ResetMultiRegion`

func ResetMultiRegion()

`ResetPolicy`

func ResetPolicy()

`ResetRotationPeriodInDays`

func ResetRotationPeriodInDays()

`ResetTags`

func ResetTags()

`ResetTagsAll`

func ResetTagsAll()

`ResetTimeouts`

func ResetTimeouts()

`ResetXksKeyId`

func ResetXksKeyId()

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 "github.com/cdktf/cdktf-provider-aws-go/aws/v19/kmskey"

kmskey.KmsKey_IsConstruct(x interface{}) *bool

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.

`x`^Required

Type: interface{}

Any object.

`IsTerraformElement`

import "github.com/cdktf/cdktf-provider-aws-go/aws/v19/kmskey"

kmskey.KmsKey_IsTerraformElement(x interface{}) *bool

`x`^Required

Type: interface{}

`IsTerraformResource`

import "github.com/cdktf/cdktf-provider-aws-go/aws/v19/kmskey"

kmskey.KmsKey_IsTerraformResource(x interface{}) *bool

`x`^Required

Type: interface{}

`GenerateConfigForImport`

import "github.com/cdktf/cdktf-provider-aws-go/aws/v19/kmskey"

kmskey.KmsKey_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

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

`scope`^Required

Type: github.com/aws/constructs-go/constructs/v10.Construct

The scope in which to define this construct.

`importToId`^Required

Type: *string

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

`importFromId`^Required

Type: *string

The id of the existing KmsKey that should be imported.

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

`provider`^Optional

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

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

Properties

Name	Type	Description
`Node`	`github.com/aws/constructs-go/constructs/v10.Node`	The tree node.
`CdktfStack`	`github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack`	No description.
`Fqn`	`*string`	No description.
`FriendlyUniqueId`	`*string`	No description.
`TerraformMetaArguments`	`*map[string]interface{}`	No description.
`TerraformResourceType`	`*string`	No description.
`TerraformGeneratorMetadata`	`github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata`	No description.
`Connection`	`interface{}`	No description.
`Count`	`interface{}`	No description.
`DependsOn`	`[]string`	No description.
`ForEach`	`github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator`	No description.
`Lifecycle`	`github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle`	No description.
`Provider`	`github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider`	No description.
`Provisioners`	`*[]interface{}`	No description.
`Arn`	`*string`	No description.
`KeyId`	`*string`	No description.
`Timeouts`	`KmsKeyTimeoutsOutputReference`	No description.
`BypassPolicyLockoutSafetyCheckInput`	`interface{}`	No description.
`CustomerMasterKeySpecInput`	`*string`	No description.
`CustomKeyStoreIdInput`	`*string`	No description.
`DeletionWindowInDaysInput`	`*f64`	No description.
`DescriptionInput`	`*string`	No description.
`EnableKeyRotationInput`	`interface{}`	No description.
`IdInput`	`*string`	No description.
`IsEnabledInput`	`interface{}`	No description.
`KeyUsageInput`	`*string`	No description.
`MultiRegionInput`	`interface{}`	No description.
`PolicyInput`	`*string`	No description.
`RotationPeriodInDaysInput`	`*f64`	No description.
`TagsAllInput`	`map[string]string`	No description.
`TagsInput`	`map[string]string`	No description.
`TimeoutsInput`	`interface{}`	No description.
`XksKeyIdInput`	`*string`	No description.
`BypassPolicyLockoutSafetyCheck`	`interface{}`	No description.
`CustomerMasterKeySpec`	`*string`	No description.
`CustomKeyStoreId`	`*string`	No description.
`DeletionWindowInDays`	`*f64`	No description.
`Description`	`*string`	No description.
`EnableKeyRotation`	`interface{}`	No description.
`Id`	`*string`	No description.
`IsEnabled`	`interface{}`	No description.
`KeyUsage`	`*string`	No description.
`MultiRegion`	`interface{}`	No description.
`Policy`	`*string`	No description.
`RotationPeriodInDays`	`*f64`	No description.
`Tags`	`map[string]string`	No description.
`TagsAll`	`map[string]string`	No description.
`XksKeyId`	`*string`	No description.

`Node`^Required

func Node() Node

Type: github.com/aws/constructs-go/constructs/v10.Node

The tree node.

`CdktfStack`^Required

func CdktfStack() TerraformStack

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack

`Fqn`^Required

func Fqn() *string

Type: *string

`FriendlyUniqueId`^Required

func FriendlyUniqueId() *string

Type: *string

`TerraformMetaArguments`^Required

func TerraformMetaArguments() *map[string]interface{}

Type: *map[string]interface{}

`TerraformResourceType`^Required

func TerraformResourceType() *string

Type: *string

`TerraformGeneratorMetadata`^Optional

func TerraformGeneratorMetadata() TerraformProviderGeneratorMetadata

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata

`Connection`^Optional

func Connection() interface{}

Type: interface{}

`Count`^Optional

func Count() interface{}

Type: interface{}

`DependsOn`^Optional

func DependsOn() *[]*string

Type: *[]*string

`ForEach`^Optional

func ForEach() ITerraformIterator

Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator

`Lifecycle`^Optional

func Lifecycle() TerraformResourceLifecycle

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle

`Provider`^Optional

func Provider() TerraformProvider

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

`Provisioners`^Optional

func Provisioners() *[]interface{}

Type: *[]interface{}

`Arn`^Required

func Arn() *string

Type: *string

`KeyId`^Required

func KeyId() *string

Type: *string

`Timeouts`^Required

func Timeouts() KmsKeyTimeoutsOutputReference

Type: KmsKeyTimeoutsOutputReference

`BypassPolicyLockoutSafetyCheckInput`^Optional

func BypassPolicyLockoutSafetyCheckInput() interface{}

Type: interface{}

`CustomerMasterKeySpecInput`^Optional

func CustomerMasterKeySpecInput() *string

Type: *string

`CustomKeyStoreIdInput`^Optional

func CustomKeyStoreIdInput() *string

Type: *string

`DeletionWindowInDaysInput`^Optional

func DeletionWindowInDaysInput() *f64

Type: *f64

`DescriptionInput`^Optional

func DescriptionInput() *string

Type: *string

`EnableKeyRotationInput`^Optional

func EnableKeyRotationInput() interface{}

Type: interface{}

`IdInput`^Optional

func IdInput() *string

Type: *string

`IsEnabledInput`^Optional

func IsEnabledInput() interface{}

Type: interface{}

`KeyUsageInput`^Optional

func KeyUsageInput() *string

Type: *string

`MultiRegionInput`^Optional

func MultiRegionInput() interface{}

Type: interface{}

`PolicyInput`^Optional

func PolicyInput() *string

Type: *string

`RotationPeriodInDaysInput`^Optional

func RotationPeriodInDaysInput() *f64

Type: *f64

`TagsAllInput`^Optional

func TagsAllInput() *map[string]*string

Type: *map[string]*string

`TagsInput`^Optional

func TagsInput() *map[string]*string

Type: *map[string]*string

`TimeoutsInput`^Optional

func TimeoutsInput() interface{}

Type: interface{}

`XksKeyIdInput`^Optional

func XksKeyIdInput() *string

Type: *string

`BypassPolicyLockoutSafetyCheck`^Required

func BypassPolicyLockoutSafetyCheck() interface{}

Type: interface{}

`CustomerMasterKeySpec`^Required

func CustomerMasterKeySpec() *string

Type: *string

`CustomKeyStoreId`^Required

func CustomKeyStoreId() *string

Type: *string

`DeletionWindowInDays`^Required

func DeletionWindowInDays() *f64

Type: *f64

`Description`^Required

func Description() *string

Type: *string

`EnableKeyRotation`^Required

func EnableKeyRotation() interface{}

Type: interface{}

`Id`^Required

func Id() *string

Type: *string

`IsEnabled`^Required

func IsEnabled() interface{}

Type: interface{}

`KeyUsage`^Required

func KeyUsage() *string

Type: *string

`MultiRegion`^Required

func MultiRegion() interface{}

Type: interface{}

`Policy`^Required

func Policy() *string

Type: *string

`RotationPeriodInDays`^Required

func RotationPeriodInDays() *f64

Type: *f64

`Tags`^Required

func Tags() *map[string]*string

Type: *map[string]*string

`TagsAll`^Required

func TagsAll() *map[string]*string

Type: *map[string]*string

`XksKeyId`^Required

func XksKeyId() *string

Type: *string

Constants

Name	Type	Description
`TfResourceType`	`*string`	No description.

`TfResourceType`^Required

func TfResourceType() *string

Type: *string

Structs

KmsKeyConfig

Initializer

import "github.com/cdktf/cdktf-provider-aws-go/aws/v19/kmskey"

&kmskey.KmsKeyConfig {
	Connection: interface{},
	Count: interface{},
	DependsOn: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable,
	ForEach: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator,
	Lifecycle: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle,
	Provider: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider,
	Provisioners: *[]interface{},
	BypassPolicyLockoutSafetyCheck: interface{},
	CustomerMasterKeySpec: *string,
	CustomKeyStoreId: *string,
	DeletionWindowInDays: *f64,
	Description: *string,
	EnableKeyRotation: interface{},
	Id: *string,
	IsEnabled: interface{},
	KeyUsage: *string,
	MultiRegion: interface{},
	Policy: *string,
	RotationPeriodInDays: *f64,
	Tags: *map[string]*string,
	TagsAll: *map[string]*string,
	Timeouts: github.com/cdktf/cdktf-provider-aws-go/aws/v19.kmsKey.KmsKeyTimeouts,
	XksKeyId: *string,
}

Properties

Name	Type	Description
`Connection`	`interface{}`	No description.
`Count`	`interface{}`	No description.
`DependsOn`	`*[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable`	No description.
`ForEach`	`github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator`	No description.
`Lifecycle`	`github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle`	No description.
`Provider`	`github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider`	No description.
`Provisioners`	`*[]interface{}`	No description.
`BypassPolicyLockoutSafetyCheck`	`interface{}`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.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/5.72.1/docs/resources/kms_key#customer_master_key_spec KmsKey#customer_master_key_spec}.
`CustomKeyStoreId`	`*string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/kms_key#custom_key_store_id KmsKey#custom_key_store_id}.
`DeletionWindowInDays`	`*f64`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.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/5.72.1/docs/resources/kms_key#description KmsKey#description}.
`EnableKeyRotation`	`interface{}`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.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/5.72.1/docs/resources/kms_key#id KmsKey#id}.
`IsEnabled`	`interface{}`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/kms_key#is_enabled KmsKey#is_enabled}.
`KeyUsage`	`*string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/kms_key#key_usage KmsKey#key_usage}.
`MultiRegion`	`interface{}`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/kms_key#multi_region KmsKey#multi_region}.
`Policy`	`*string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/kms_key#policy KmsKey#policy}.
`RotationPeriodInDays`	`*f64`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/kms_key#rotation_period_in_days KmsKey#rotation_period_in_days}.
`Tags`	`map[string]string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/kms_key#tags KmsKey#tags}.
`TagsAll`	`map[string]string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/kms_key#tags_all KmsKey#tags_all}.
`Timeouts`	`KmsKeyTimeouts`	timeouts block.
`XksKeyId`	`*string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/kms_key#xks_key_id KmsKey#xks_key_id}.

`Connection`^Optional

Connection interface{}

Type: interface{}

`Count`^Optional

Count interface{}

Type: interface{}

`DependsOn`^Optional

DependsOn *[]ITerraformDependable

Type: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable

`ForEach`^Optional

ForEach ITerraformIterator

Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator

`Lifecycle`^Optional

Lifecycle TerraformResourceLifecycle

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle

`Provider`^Optional

Provider TerraformProvider

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

`Provisioners`^Optional

Provisioners *[]interface{}

Type: *[]interface{}

`BypassPolicyLockoutSafetyCheck`^Optional

BypassPolicyLockoutSafetyCheck interface{}

Type: interface{}

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

`CustomerMasterKeySpec`^Optional

CustomerMasterKeySpec *string

Type: *string

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

`CustomKeyStoreId`^Optional

CustomKeyStoreId *string

Type: *string

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

`DeletionWindowInDays`^Optional

DeletionWindowInDays *f64

Type: *f64

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

`Description`^Optional

Description *string

Type: *string

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

`EnableKeyRotation`^Optional

EnableKeyRotation interface{}

Type: interface{}

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

`Id`^Optional

Id *string

Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.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.

`IsEnabled`^Optional

IsEnabled interface{}

Type: interface{}

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

`KeyUsage`^Optional

KeyUsage *string

Type: *string

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

`MultiRegion`^Optional

MultiRegion interface{}

Type: interface{}

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

`Policy`^Optional

Policy *string

Type: *string

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

`RotationPeriodInDays`^Optional

RotationPeriodInDays *f64

Type: *f64

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

`Tags`^Optional

Tags *map[string]*string

Type: *map[string]*string

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

`TagsAll`^Optional

TagsAll *map[string]*string

Type: *map[string]*string

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

`Timeouts`^Optional

Timeouts KmsKeyTimeouts

Type: KmsKeyTimeouts

timeouts block.

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

`XksKeyId`^Optional

XksKeyId *string

Type: *string

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

KmsKeyTimeouts

Initializer

import "github.com/cdktf/cdktf-provider-aws-go/aws/v19/kmskey"

&kmskey.KmsKeyTimeouts {
	Create: *string,
}

Properties

Name	Type	Description
`Create`	`*string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/kms_key#create KmsKey#create}.

`Create`^Optional

Create *string

Type: *string

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

Classes

KmsKeyTimeoutsOutputReference

Initializers

import "github.com/cdktf/cdktf-provider-aws-go/aws/v19/kmskey"

kmskey.NewKmsKeyTimeoutsOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string) KmsKeyTimeoutsOutputReference

Name	Type	Description
`terraformResource`	`github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`*string`	The attribute on the parent resource this class is referencing.

`terraformResource`^Required

Type: github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: *string

The attribute on the parent resource this class is referencing.

Methods

Name	Description
`ComputeFqn`	No description.
`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.
`InterpolationForAttribute`	No description.
`Resolve`	Produce the Token's value at resolution time.
`ToString`	Return a string representation of this resolvable object.
`ResetCreate`	No description.

`ComputeFqn`

func ComputeFqn() *string

`GetAnyMapAttribute`

func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}

`terraformAttribute`^Required

Type: *string

`GetBooleanAttribute`

func GetBooleanAttribute(terraformAttribute *string) IResolvable

`terraformAttribute`^Required

Type: *string

`GetBooleanMapAttribute`

func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool

`terraformAttribute`^Required

Type: *string

`GetListAttribute`

func GetListAttribute(terraformAttribute *string) *[]*string

`terraformAttribute`^Required

Type: *string

`GetNumberAttribute`

func GetNumberAttribute(terraformAttribute *string) *f64

`terraformAttribute`^Required

Type: *string

`GetNumberListAttribute`

func GetNumberListAttribute(terraformAttribute *string) *[]*f64

`terraformAttribute`^Required

Type: *string

`GetNumberMapAttribute`

func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64

`terraformAttribute`^Required

Type: *string

`GetStringAttribute`

func GetStringAttribute(terraformAttribute *string) *string

`terraformAttribute`^Required

Type: *string

`GetStringMapAttribute`

func GetStringMapAttribute(terraformAttribute *string) *map[string]*string

`terraformAttribute`^Required

Type: *string

`InterpolationForAttribute`

func InterpolationForAttribute(property *string) IResolvable

`property`^Required

Type: *string

`Resolve`

func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

`_context`^Required

Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext

`ToString`

func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`ResetCreate`

func ResetCreate()

Properties

Name	Type	Description
`CreationStack`	`[]string`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`Fqn`	`*string`	No description.
`CreateInput`	`*string`	No description.
`Create`	`*string`	No description.
`InternalValue`	`interface{}`	No description.

`CreationStack`^Required

func CreationStack() *[]*string

Type: *[]*string

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`Fqn`^Required

func Fqn() *string

Type: *string

`CreateInput`^Optional

func CreateInput() *string

Type: *string

`Create`^Required

func Create() *string

Type: *string

`InternalValue`^Optional

func InternalValue() interface{}

Type: interface{}

Files

kmsKey.go.md

Latest commit

History

kmsKey.go.md

File metadata and controls

kmsKey Submodule

Constructs

KmsKey

Initializers

scopeRequired

idRequired

configOptional

Methods

ToString

AddOverride

pathRequired

valueRequired

OverrideLogicalId

newLogicalIdRequired

ResetOverrideLogicalId

ToHclTerraform

ToMetadata

ToTerraform

AddMoveTarget

moveTargetRequired

GetAnyMapAttribute

terraformAttributeRequired

GetBooleanAttribute

terraformAttributeRequired

GetBooleanMapAttribute

terraformAttributeRequired

GetListAttribute

terraformAttributeRequired

GetNumberAttribute

terraformAttributeRequired

GetNumberListAttribute

terraformAttributeRequired

GetNumberMapAttribute

terraformAttributeRequired

GetStringAttribute

terraformAttributeRequired

GetStringMapAttribute

terraformAttributeRequired

HasResourceMove

ImportFrom

idRequired

providerOptional

InterpolationForAttribute

terraformAttributeRequired

MoveFromId

idRequired

MoveTo

moveTargetRequired

indexOptional

MoveToId

idRequired

PutTimeouts

valueRequired

ResetBypassPolicyLockoutSafetyCheck

ResetCustomerMasterKeySpec

ResetCustomKeyStoreId

ResetDeletionWindowInDays

ResetDescription

ResetEnableKeyRotation

ResetId

ResetIsEnabled

ResetKeyUsage

ResetMultiRegion

ResetPolicy

ResetRotationPeriodInDays

ResetTags

ResetTagsAll

ResetTimeouts

ResetXksKeyId

Static Functions

IsConstruct

xRequired

IsTerraformElement

xRequired

`kmsKey` Submodule

`scope`^Required

`id`^Required

`config`^Optional

`ToString`

`AddOverride`

`path`^Required

`value`^Required

`OverrideLogicalId`

`newLogicalId`^Required

`ResetOverrideLogicalId`

`ToHclTerraform`

`ToMetadata`

`ToTerraform`

`AddMoveTarget`

`moveTarget`^Required

`GetAnyMapAttribute`

`terraformAttribute`^Required

`GetBooleanAttribute`

`terraformAttribute`^Required

`GetBooleanMapAttribute`

`terraformAttribute`^Required

`GetListAttribute`

`terraformAttribute`^Required

`GetNumberAttribute`

`terraformAttribute`^Required

`GetNumberListAttribute`

`terraformAttribute`^Required

`GetNumberMapAttribute`

`terraformAttribute`^Required

`GetStringAttribute`

`terraformAttribute`^Required

`GetStringMapAttribute`

`terraformAttribute`^Required

`HasResourceMove`

`ImportFrom`

`id`^Required

`provider`^Optional

`InterpolationForAttribute`

`terraformAttribute`^Required

`MoveFromId`

`id`^Required

`MoveTo`

`moveTarget`^Required

`index`^Optional

`MoveToId`

`id`^Required

`PutTimeouts`

`value`^Required

`ResetBypassPolicyLockoutSafetyCheck`

`ResetCustomerMasterKeySpec`

`ResetCustomKeyStoreId`

`ResetDeletionWindowInDays`

`ResetDescription`

`ResetEnableKeyRotation`

`ResetId`

`ResetIsEnabled`

`ResetKeyUsage`

`ResetMultiRegion`

`ResetPolicy`

`ResetRotationPeriodInDays`

`ResetTags`

`ResetTagsAll`

`ResetTimeouts`

`ResetXksKeyId`

`IsConstruct`

`x`^Required

`IsTerraformElement`

`x`^Required

`IsTerraformResource`

`x`^Required

`GenerateConfigForImport`

`scope`^Required

`importToId`^Required

`importFromId`^Required

`provider`^Optional

`Node`^Required

`CdktfStack`^Required

`Fqn`^Required

`FriendlyUniqueId`^Required