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

kmsKey.python.md

Latest commit

 

History

History
2158 lines (1381 loc) · 86 KB

kmsKey.python.md

File metadata and controls

2158 lines (1381 loc) · 86 KB

kmsKey Submodule

Constructs

KmsKey

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

Initializers 

from cdktf_cdktf_provider_aws import kms_key

kmsKey.KmsKey(
  scope: Construct,
  id: str,
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  count: typing.Union[int, float] | TerraformCount = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
  bypass_policy_lockout_safety_check: bool | IResolvable = None,
  customer_master_key_spec: str = None,
  custom_key_store_id: str = None,
  deletion_window_in_days: typing.Union[int, float] = None,
  description: str = None,
  enable_key_rotation: bool | IResolvable = None,
  id: str = None,
  is_enabled: bool | IResolvable = None,
  key_usage: str = None,
  multi_region: bool | IResolvable = None,
  policy: str = None,
  region: str = None,
  rotation_period_in_days: typing.Union[int, float] = None,
  tags: typing.Mapping[str] = None,
  tags_all: typing.Mapping[str] = None,
  timeouts: KmsKeyTimeouts = None,
  xks_key_id: str = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count typing.Union[int, float] | cdktf.TerraformCount No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner] No description.
bypass_policy_lockout_safety_check bool | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_key#bypass_policy_lockout_safety_check KmsKey#bypass_policy_lockout_safety_check}.
customer_master_key_spec str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_key#customer_master_key_spec KmsKey#customer_master_key_spec}.
custom_key_store_id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_key#custom_key_store_id KmsKey#custom_key_store_id}.
deletion_window_in_days typing.Union[int, float] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_key#deletion_window_in_days KmsKey#deletion_window_in_days}.
description str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_key#description KmsKey#description}.
enable_key_rotation bool | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_key#enable_key_rotation KmsKey#enable_key_rotation}.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_key#id KmsKey#id}.
is_enabled bool | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_key#is_enabled KmsKey#is_enabled}.
key_usage str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_key#key_usage KmsKey#key_usage}.
multi_region bool | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_key#multi_region KmsKey#multi_region}.
policy str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_key#policy KmsKey#policy}.
region str Region where this resource will be managed. Defaults to the Region set in the provider configuration.
rotation_period_in_days typing.Union[int, float] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_key#rotation_period_in_days KmsKey#rotation_period_in_days}.
tags typing.Mapping[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_key#tags KmsKey#tags}.
tags_all typing.Mapping[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_key#tags_all KmsKey#tags_all}.
timeouts KmsKeyTimeouts timeouts block.
xks_key_id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_key#xks_key_id KmsKey#xks_key_id}.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional
  • Type: typing.Union[int, float] | cdktf.TerraformCount
depends_onOptional
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional
  • Type: cdktf.ITerraformIterator
lifecycleOptional
  • Type: cdktf.TerraformResourceLifecycle
providerOptional
  • Type: cdktf.TerraformProvider
provisionersOptional
  • Type: typing.List[cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner]
bypass_policy_lockout_safety_checkOptional
  • Type: bool | cdktf.IResolvable

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

customer_master_key_specOptional
  • Type: str

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

custom_key_store_idOptional
  • Type: str

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

deletion_window_in_daysOptional
  • Type: typing.Union[int, float]

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

descriptionOptional
  • Type: str

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

enable_key_rotationOptional
  • Type: bool | cdktf.IResolvable

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

idOptional
  • Type: str

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

is_enabledOptional
  • Type: bool | cdktf.IResolvable

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

key_usageOptional
  • Type: str

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

multi_regionOptional
  • Type: bool | cdktf.IResolvable

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

policyOptional
  • Type: str

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

regionOptional
  • Type: str

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

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

rotation_period_in_daysOptional
  • Type: typing.Union[int, float]

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

tagsOptional
  • Type: typing.Mapping[str]

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

tags_allOptional
  • Type: typing.Mapping[str]

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

timeoutsOptional

timeouts block.

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

xks_key_idOptional
  • Type: str

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

Methods

Name Description
to_string Returns a string representation of this construct.
add_override No description.
override_logical_id Overrides the auto-generated logical ID with a specific ID.
reset_override_logical_id Resets a previously passed logical Id to use the auto-generated logical id again.
to_hcl_terraform No description.
to_metadata No description.
to_terraform Adds this resource to the terraform JSON output.
add_move_target Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
has_resource_move No description.
import_from No description.
interpolation_for_attribute No description.
move_from_id Move the resource corresponding to "id" to this resource.
move_to Moves this resource to the target resource given by moveTarget.
move_to_id Moves this resource to the resource corresponding to "id".
put_timeouts No description.
reset_bypass_policy_lockout_safety_check No description.
reset_customer_master_key_spec No description.
reset_custom_key_store_id No description.
reset_deletion_window_in_days No description.
reset_description No description.
reset_enable_key_rotation No description.
reset_id No description.
reset_is_enabled No description.
reset_key_usage No description.
reset_multi_region No description.
reset_policy No description.
reset_region No description.
reset_rotation_period_in_days No description.
reset_tags No description.
reset_tags_all No description.
reset_timeouts No description.
reset_xks_key_id No description.
to_string 
def to_string() -> str

Returns a string representation of this construct.

add_override 
def add_override(
  path: str,
  value: typing.Any
) -> None
pathRequired
  • Type: str
valueRequired
  • Type: typing.Any
override_logical_id 
def override_logical_id(
  new_logical_id: str
) -> None

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

new_logical_idRequired
  • Type: str

The new logical ID to use for this stack element.

reset_override_logical_id 
def reset_override_logical_id() -> None

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

to_hcl_terraform 
def to_hcl_terraform() -> typing.Any
to_metadata 
def to_metadata() -> typing.Any
to_terraform 
def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

add_move_target 
def add_move_target(
  move_target: str
) -> None

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

move_targetRequired
  • Type: str

The string move target that will correspond to this resource.

get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
has_resource_move 
def has_resource_move() -> TerraformResourceMoveByTarget | TerraformResourceMoveById
import_from 
def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None
idRequired
  • Type: str
providerOptional
  • Type: cdktf.TerraformProvider
interpolation_for_attribute 
def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
move_from_id 
def move_from_id(
  id: str
) -> None

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: str

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

move_to 
def move_to(
  move_target: str,
  index: str | typing.Union[int, float] = None
) -> None

Moves this resource to the target resource given by moveTarget.

move_targetRequired
  • Type: str

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

indexOptional
  • Type: str | typing.Union[int, float]

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

move_to_id 
def move_to_id(
  id: str
) -> None

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

idRequired
  • Type: str

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

put_timeouts 
def put_timeouts(
  create: str = None
) -> None
createOptional
  • Type: str

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

reset_bypass_policy_lockout_safety_check 
def reset_bypass_policy_lockout_safety_check() -> None
reset_customer_master_key_spec 
def reset_customer_master_key_spec() -> None
reset_custom_key_store_id 
def reset_custom_key_store_id() -> None
reset_deletion_window_in_days 
def reset_deletion_window_in_days() -> None
reset_description 
def reset_description() -> None
reset_enable_key_rotation 
def reset_enable_key_rotation() -> None
reset_id 
def reset_id() -> None
reset_is_enabled 
def reset_is_enabled() -> None
reset_key_usage 
def reset_key_usage() -> None
reset_multi_region 
def reset_multi_region() -> None
reset_policy 
def reset_policy() -> None
reset_region 
def reset_region() -> None
reset_rotation_period_in_days 
def reset_rotation_period_in_days() -> None
reset_tags 
def reset_tags() -> None
reset_tags_all 
def reset_tags_all() -> None
reset_timeouts 
def reset_timeouts() -> None
reset_xks_key_id 
def reset_xks_key_id() -> None

Static Functions

Name Description
is_construct Checks if x is a construct.
is_terraform_element No description.
is_terraform_resource No description.
generate_config_for_import Generates CDKTF code for importing a KmsKey resource upon running "cdktf plan ".
is_construct 
from cdktf_cdktf_provider_aws import kms_key

kmsKey.KmsKey.is_construct(
  x: typing.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: typing.Any

Any object.

is_terraform_element 
from cdktf_cdktf_provider_aws import kms_key

kmsKey.KmsKey.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktf_cdktf_provider_aws import kms_key

kmsKey.KmsKey.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_aws import kms_key

kmsKey.KmsKey.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

import_to_idRequired
  • Type: str

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

import_from_idRequired
  • Type: str

The id of the existing KmsKey that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/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.
cdktf_stack cdktf.TerraformStack No description.
fqn str No description.
friendly_unique_id str No description.
terraform_meta_arguments typing.Mapping[typing.Any] No description.
terraform_resource_type str No description.
terraform_generator_metadata cdktf.TerraformProviderGeneratorMetadata No description.
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count typing.Union[int, float] | cdktf.TerraformCount No description.
depends_on typing.List[str] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner] No description.
arn str No description.
key_id str No description.
timeouts KmsKeyTimeoutsOutputReference No description.
bypass_policy_lockout_safety_check_input bool | cdktf.IResolvable No description.
customer_master_key_spec_input str No description.
custom_key_store_id_input str No description.
deletion_window_in_days_input typing.Union[int, float] No description.
description_input str No description.
enable_key_rotation_input bool | cdktf.IResolvable No description.
id_input str No description.
is_enabled_input bool | cdktf.IResolvable No description.
key_usage_input str No description.
multi_region_input bool | cdktf.IResolvable No description.
policy_input str No description.
region_input str No description.
rotation_period_in_days_input typing.Union[int, float] No description.
tags_all_input typing.Mapping[str] No description.
tags_input typing.Mapping[str] No description.
timeouts_input cdktf.IResolvable | KmsKeyTimeouts No description.
xks_key_id_input str No description.
bypass_policy_lockout_safety_check bool | cdktf.IResolvable No description.
customer_master_key_spec str No description.
custom_key_store_id str No description.
deletion_window_in_days typing.Union[int, float] No description.
description str No description.
enable_key_rotation bool | cdktf.IResolvable No description.
id str No description.
is_enabled bool | cdktf.IResolvable No description.
key_usage str No description.
multi_region bool | cdktf.IResolvable No description.
policy str No description.
region str No description.
rotation_period_in_days typing.Union[int, float] No description.
tags typing.Mapping[str] No description.
tags_all typing.Mapping[str] No description.
xks_key_id str No description.
nodeRequired 
node: Node
  • Type: constructs.Node

The tree node.

cdktf_stackRequired 
cdktf_stack: TerraformStack
  • Type: cdktf.TerraformStack
fqnRequired 
fqn: str
  • Type: str
friendly_unique_idRequired 
friendly_unique_id: str
  • Type: str
terraform_meta_argumentsRequired 
terraform_meta_arguments: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]
terraform_resource_typeRequired 
terraform_resource_type: str
  • Type: str
terraform_generator_metadataOptional 
terraform_generator_metadata: TerraformProviderGeneratorMetadata
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
connection: SSHProvisionerConnection | WinrmProvisionerConnection
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
count: typing.Union[int, float] | TerraformCount
  • Type: typing.Union[int, float] | cdktf.TerraformCount
depends_onOptional 
depends_on: typing.List[str]
  • Type: typing.List[str]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]
  • Type: typing.List[cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner]
arnRequired 
arn: str
  • Type: str
key_idRequired 
key_id: str
  • Type: str
timeoutsRequired 
timeouts: KmsKeyTimeoutsOutputReference
bypass_policy_lockout_safety_check_inputOptional 
bypass_policy_lockout_safety_check_input: bool | IResolvable
  • Type: bool | cdktf.IResolvable
customer_master_key_spec_inputOptional 
customer_master_key_spec_input: str
  • Type: str
custom_key_store_id_inputOptional 
custom_key_store_id_input: str
  • Type: str
deletion_window_in_days_inputOptional 
deletion_window_in_days_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
description_inputOptional 
description_input: str
  • Type: str
enable_key_rotation_inputOptional 
enable_key_rotation_input: bool | IResolvable
  • Type: bool | cdktf.IResolvable
id_inputOptional 
id_input: str
  • Type: str
is_enabled_inputOptional 
is_enabled_input: bool | IResolvable
  • Type: bool | cdktf.IResolvable
key_usage_inputOptional 
key_usage_input: str
  • Type: str
multi_region_inputOptional 
multi_region_input: bool | IResolvable
  • Type: bool | cdktf.IResolvable
policy_inputOptional 
policy_input: str
  • Type: str
region_inputOptional 
region_input: str
  • Type: str
rotation_period_in_days_inputOptional 
rotation_period_in_days_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
tags_all_inputOptional 
tags_all_input: typing.Mapping[str]
  • Type: typing.Mapping[str]
tags_inputOptional 
tags_input: typing.Mapping[str]
  • Type: typing.Mapping[str]
timeouts_inputOptional 
timeouts_input: IResolvable | KmsKeyTimeouts
xks_key_id_inputOptional 
xks_key_id_input: str
  • Type: str
bypass_policy_lockout_safety_checkRequired 
bypass_policy_lockout_safety_check: bool | IResolvable
  • Type: bool | cdktf.IResolvable
customer_master_key_specRequired 
customer_master_key_spec: str
  • Type: str
custom_key_store_idRequired 
custom_key_store_id: str
  • Type: str
deletion_window_in_daysRequired 
deletion_window_in_days: typing.Union[int, float]
  • Type: typing.Union[int, float]
descriptionRequired 
description: str
  • Type: str
enable_key_rotationRequired 
enable_key_rotation: bool | IResolvable
  • Type: bool | cdktf.IResolvable
idRequired 
id: str
  • Type: str
is_enabledRequired 
is_enabled: bool | IResolvable
  • Type: bool | cdktf.IResolvable
key_usageRequired 
key_usage: str
  • Type: str
multi_regionRequired 
multi_region: bool | IResolvable
  • Type: bool | cdktf.IResolvable
policyRequired 
policy: str
  • Type: str
regionRequired 
region: str
  • Type: str
rotation_period_in_daysRequired 
rotation_period_in_days: typing.Union[int, float]
  • Type: typing.Union[int, float]
tagsRequired 
tags: typing.Mapping[str]
  • Type: typing.Mapping[str]
tags_allRequired 
tags_all: typing.Mapping[str]
  • Type: typing.Mapping[str]
xks_key_idRequired 
xks_key_id: str
  • Type: str

Constants

Name Type Description
tfResourceType str No description.
tfResourceTypeRequired 
tfResourceType: str
  • Type: str

Structs

KmsKeyConfig

Initializer 

from cdktf_cdktf_provider_aws import kms_key

kmsKey.KmsKeyConfig(
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  count: typing.Union[int, float] | TerraformCount = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
  bypass_policy_lockout_safety_check: bool | IResolvable = None,
  customer_master_key_spec: str = None,
  custom_key_store_id: str = None,
  deletion_window_in_days: typing.Union[int, float] = None,
  description: str = None,
  enable_key_rotation: bool | IResolvable = None,
  id: str = None,
  is_enabled: bool | IResolvable = None,
  key_usage: str = None,
  multi_region: bool | IResolvable = None,
  policy: str = None,
  region: str = None,
  rotation_period_in_days: typing.Union[int, float] = None,
  tags: typing.Mapping[str] = None,
  tags_all: typing.Mapping[str] = None,
  timeouts: KmsKeyTimeouts = None,
  xks_key_id: str = None
)

Properties

Name Type Description
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count typing.Union[int, float] | cdktf.TerraformCount No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner] No description.
bypass_policy_lockout_safety_check bool | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_key#bypass_policy_lockout_safety_check KmsKey#bypass_policy_lockout_safety_check}.
customer_master_key_spec str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_key#customer_master_key_spec KmsKey#customer_master_key_spec}.
custom_key_store_id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_key#custom_key_store_id KmsKey#custom_key_store_id}.
deletion_window_in_days typing.Union[int, float] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_key#deletion_window_in_days KmsKey#deletion_window_in_days}.
description str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_key#description KmsKey#description}.
enable_key_rotation bool | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_key#enable_key_rotation KmsKey#enable_key_rotation}.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_key#id KmsKey#id}.
is_enabled bool | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_key#is_enabled KmsKey#is_enabled}.
key_usage str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_key#key_usage KmsKey#key_usage}.
multi_region bool | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_key#multi_region KmsKey#multi_region}.
policy str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_key#policy KmsKey#policy}.
region str Region where this resource will be managed. Defaults to the Region set in the provider configuration.
rotation_period_in_days typing.Union[int, float] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_key#rotation_period_in_days KmsKey#rotation_period_in_days}.
tags typing.Mapping[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_key#tags KmsKey#tags}.
tags_all typing.Mapping[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_key#tags_all KmsKey#tags_all}.
timeouts KmsKeyTimeouts timeouts block.
xks_key_id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_key#xks_key_id KmsKey#xks_key_id}.
connectionOptional 
connection: SSHProvisionerConnection | WinrmProvisionerConnection
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
count: typing.Union[int, float] | TerraformCount
  • Type: typing.Union[int, float] | cdktf.TerraformCount
depends_onOptional 
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]
  • Type: typing.List[cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner]
bypass_policy_lockout_safety_checkOptional 
bypass_policy_lockout_safety_check: bool | IResolvable
  • Type: bool | cdktf.IResolvable

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

customer_master_key_specOptional 
customer_master_key_spec: str
  • Type: str

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

custom_key_store_idOptional 
custom_key_store_id: str
  • Type: str

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

deletion_window_in_daysOptional 
deletion_window_in_days: typing.Union[int, float]
  • Type: typing.Union[int, float]

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

descriptionOptional 
description: str
  • Type: str

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

enable_key_rotationOptional 
enable_key_rotation: bool | IResolvable
  • Type: bool | cdktf.IResolvable

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

idOptional 
id: str
  • Type: str

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

is_enabledOptional 
is_enabled: bool | IResolvable
  • Type: bool | cdktf.IResolvable

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

key_usageOptional 
key_usage: str
  • Type: str

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

multi_regionOptional 
multi_region: bool | IResolvable
  • Type: bool | cdktf.IResolvable

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

policyOptional 
policy: str
  • Type: str

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

regionOptional 
region: str
  • Type: str

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

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

rotation_period_in_daysOptional 
rotation_period_in_days: typing.Union[int, float]
  • Type: typing.Union[int, float]

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

tagsOptional 
tags: typing.Mapping[str]
  • Type: typing.Mapping[str]

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

tags_allOptional 
tags_all: typing.Mapping[str]
  • Type: typing.Mapping[str]

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

timeoutsOptional 
timeouts: KmsKeyTimeouts

timeouts block.

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

xks_key_idOptional 
xks_key_id: str
  • Type: str

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

KmsKeyTimeouts

Initializer 

from cdktf_cdktf_provider_aws import kms_key

kmsKey.KmsKeyTimeouts(
  create: str = None
)

Properties

Name Type Description
create str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_key#create KmsKey#create}.
createOptional 
create: str
  • Type: str

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

Classes

KmsKeyTimeoutsOutputReference

Initializers 

from cdktf_cdktf_provider_aws import kms_key

kmsKey.KmsKeyTimeoutsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
reset_create No description.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_create 
def reset_create() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
create_input str No description.
create str No description.
internal_value cdktf.IResolvable | KmsKeyTimeouts No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

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.

fqnRequired 
fqn: str
  • Type: str
create_inputOptional 
create_input: str
  • Type: str
createRequired 
create: str
  • Type: str
internal_valueOptional 
internal_value: IResolvable | KmsKeyTimeouts