`kmsCustomKeyStore` Submodule

Constructs

KmsCustomKeyStore

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store aws_kms_custom_key_store}.

Initializers

from cdktn_provider_aws import kms_custom_key_store

kmsCustomKeyStore.KmsCustomKeyStore(
  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,
  custom_key_store_name: str,
  cloud_hsm_cluster_id: str = None,
  custom_key_store_type: str = None,
  id: str = None,
  key_store_password: str = None,
  region: str = None,
  timeouts: KmsCustomKeyStoreTimeouts = None,
  trust_anchor_certificate: str = None,
  xks_proxy_authentication_credential: KmsCustomKeyStoreXksProxyAuthenticationCredential = None,
  xks_proxy_connectivity: str = None,
  xks_proxy_uri_endpoint: str = None,
  xks_proxy_uri_path: str = None,
  xks_proxy_vpc_endpoint_service_name: str = None
)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`str`	The scoped construct ID.
`connection`	`cdktn.SSHProvisionerConnection \| cdktn.WinrmProvisionerConnection`	No description.
`count`	`typing.Union[int, float] \| cdktn.TerraformCount`	No description.
`depends_on`	`typing.List[cdktn.ITerraformDependable]`	No description.
`for_each`	`cdktn.ITerraformIterator`	No description.
`lifecycle`	`cdktn.TerraformResourceLifecycle`	No description.
`provider`	`cdktn.TerraformProvider`	No description.
`provisioners`	`typing.List[cdktn.FileProvisioner \| cdktn.LocalExecProvisioner \| cdktn.RemoteExecProvisioner]`	No description.
`custom_key_store_name`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#custom_key_store_name KmsCustomKeyStore#custom_key_store_name}.
`cloud_hsm_cluster_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#cloud_hsm_cluster_id KmsCustomKeyStore#cloud_hsm_cluster_id}.
`custom_key_store_type`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#custom_key_store_type KmsCustomKeyStore#custom_key_store_type}.
`id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#id KmsCustomKeyStore#id}.
`key_store_password`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#key_store_password KmsCustomKeyStore#key_store_password}.
`region`	`str`	Region where this resource will be managed. Defaults to the Region set in the provider configuration.
`timeouts`	`KmsCustomKeyStoreTimeouts`	timeouts block.
`trust_anchor_certificate`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#trust_anchor_certificate KmsCustomKeyStore#trust_anchor_certificate}.
`xks_proxy_authentication_credential`	`KmsCustomKeyStoreXksProxyAuthenticationCredential`	xks_proxy_authentication_credential block.
`xks_proxy_connectivity`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#xks_proxy_connectivity KmsCustomKeyStore#xks_proxy_connectivity}.
`xks_proxy_uri_endpoint`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#xks_proxy_uri_endpoint KmsCustomKeyStore#xks_proxy_uri_endpoint}.
`xks_proxy_uri_path`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#xks_proxy_uri_path KmsCustomKeyStore#xks_proxy_uri_path}.
`xks_proxy_vpc_endpoint_service_name`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#xks_proxy_vpc_endpoint_service_name KmsCustomKeyStore#xks_proxy_vpc_endpoint_service_name}.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

`connection`^Optional

Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

`count`^Optional

Type: typing.Union[int, float] | cdktn.TerraformCount

`depends_on`^Optional

Type: typing.List[cdktn.ITerraformDependable]

`for_each`^Optional

Type: cdktn.ITerraformIterator

`lifecycle`^Optional

Type: cdktn.TerraformResourceLifecycle

`provider`^Optional

Type: cdktn.TerraformProvider

`provisioners`^Optional

Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]

`custom_key_store_name`^Required

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#custom_key_store_name KmsCustomKeyStore#custom_key_store_name}.

`cloud_hsm_cluster_id`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#cloud_hsm_cluster_id KmsCustomKeyStore#cloud_hsm_cluster_id}.

`custom_key_store_type`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#custom_key_store_type KmsCustomKeyStore#custom_key_store_type}.

`id`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#id KmsCustomKeyStore#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.

`key_store_password`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#key_store_password KmsCustomKeyStore#key_store_password}.

`region`^Optional

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.50.0/docs/resources/kms_custom_key_store#region KmsCustomKeyStore#region}

`timeouts`^Optional

Type: KmsCustomKeyStoreTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#timeouts KmsCustomKeyStore#timeouts}

`trust_anchor_certificate`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#trust_anchor_certificate KmsCustomKeyStore#trust_anchor_certificate}.

`xks_proxy_authentication_credential`^Optional

Type: KmsCustomKeyStoreXksProxyAuthenticationCredential

xks_proxy_authentication_credential block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#xks_proxy_authentication_credential KmsCustomKeyStore#xks_proxy_authentication_credential}

`xks_proxy_connectivity`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#xks_proxy_connectivity KmsCustomKeyStore#xks_proxy_connectivity}.

`xks_proxy_uri_endpoint`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#xks_proxy_uri_endpoint KmsCustomKeyStore#xks_proxy_uri_endpoint}.

`xks_proxy_uri_path`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#xks_proxy_uri_path KmsCustomKeyStore#xks_proxy_uri_path}.

`xks_proxy_vpc_endpoint_service_name`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#xks_proxy_vpc_endpoint_service_name KmsCustomKeyStore#xks_proxy_vpc_endpoint_service_name}.

Methods

Name	Description
`to_string`	Returns a string representation of this construct.
`with`	Applies one or more mixins to 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.
`put_xks_proxy_authentication_credential`	No description.
`reset_cloud_hsm_cluster_id`	No description.
`reset_custom_key_store_type`	No description.
`reset_id`	No description.
`reset_key_store_password`	No description.
`reset_region`	No description.
`reset_timeouts`	No description.
`reset_trust_anchor_certificate`	No description.
`reset_xks_proxy_authentication_credential`	No description.
`reset_xks_proxy_connectivity`	No description.
`reset_xks_proxy_uri_endpoint`	No description.
`reset_xks_proxy_uri_path`	No description.
`reset_xks_proxy_vpc_endpoint_service_name`	No description.

`to_string`

def to_string() -> str

Returns a string representation of this construct.

`with`

def with(
  mixins: *IMixin
) -> IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

`mixins`^Required

Type: *constructs.IMixin

The mixins to apply.

`add_override`

def add_override(
  path: str,
  value: typing.Any
) -> None

`path`^Required

Type: str

`value`^Required

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_id`^Required

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_target`^Required

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_attribute`^Required

Type: str

`get_boolean_attribute`

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`get_boolean_map_attribute`

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

`terraform_attribute`^Required

Type: str

`get_list_attribute`

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

`terraform_attribute`^Required

Type: str

`get_number_attribute`

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

`terraform_attribute`^Required

Type: str

`get_number_list_attribute`

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_number_map_attribute`

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_string_attribute`

def get_string_attribute(
  terraform_attribute: str
) -> str

`terraform_attribute`^Required

Type: str

`get_string_map_attribute`

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

`terraform_attribute`^Required

Type: str

`has_resource_move`

def has_resource_move() -> TerraformResourceMoveByTarget | TerraformResourceMoveById

`import_from`

def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None

`id`^Required

Type: str

`provider`^Optional

Type: cdktn.TerraformProvider

`interpolation_for_attribute`

def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

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.

`id`^Required

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_target`^Required

Type: str

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

`index`^Optional

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".

`id`^Required

Type: str

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

`put_timeouts`

def put_timeouts(
  create: str = None,
  delete: str = None,
  update: str = None
) -> None

`create`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#create KmsCustomKeyStore#create}.

`delete`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#delete KmsCustomKeyStore#delete}.

`update`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#update KmsCustomKeyStore#update}.

`put_xks_proxy_authentication_credential`

def put_xks_proxy_authentication_credential(
  access_key_id: str,
  raw_secret_access_key: str
) -> None

`access_key_id`^Required

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#access_key_id KmsCustomKeyStore#access_key_id}.

`raw_secret_access_key`^Required

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#raw_secret_access_key KmsCustomKeyStore#raw_secret_access_key}.

`reset_cloud_hsm_cluster_id`

def reset_cloud_hsm_cluster_id() -> None

`reset_custom_key_store_type`

def reset_custom_key_store_type() -> None

`reset_id`

def reset_id() -> None

`reset_key_store_password`

def reset_key_store_password() -> None

`reset_region`

def reset_region() -> None

`reset_timeouts`

def reset_timeouts() -> None

`reset_trust_anchor_certificate`

def reset_trust_anchor_certificate() -> None

`reset_xks_proxy_authentication_credential`

def reset_xks_proxy_authentication_credential() -> None

`reset_xks_proxy_connectivity`

def reset_xks_proxy_connectivity() -> None

`reset_xks_proxy_uri_endpoint`

def reset_xks_proxy_uri_endpoint() -> None

`reset_xks_proxy_uri_path`

def reset_xks_proxy_uri_path() -> None

`reset_xks_proxy_vpc_endpoint_service_name`

def reset_xks_proxy_vpc_endpoint_service_name() -> 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 CDKTN code for importing a KmsCustomKeyStore resource upon running "cdktn plan ".

`is_construct`

from cdktn_provider_aws import kms_custom_key_store

kmsCustomKeyStore.KmsCustomKeyStore.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.

`x`^Required

Type: typing.Any

Any object.

`is_terraform_element`

from cdktn_provider_aws import kms_custom_key_store

kmsCustomKeyStore.KmsCustomKeyStore.is_terraform_element(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`is_terraform_resource`

from cdktn_provider_aws import kms_custom_key_store

kmsCustomKeyStore.KmsCustomKeyStore.is_terraform_resource(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`generate_config_for_import`

from cdktn_provider_aws import kms_custom_key_store

kmsCustomKeyStore.KmsCustomKeyStore.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

Generates CDKTN code for importing a KmsCustomKeyStore resource upon running "cdktn plan ".

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`import_to_id`^Required

Type: str

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

`import_from_id`^Required

Type: str

The id of the existing KmsCustomKeyStore that should be imported.

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

`provider`^Optional

Type: cdktn.TerraformProvider

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

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`cdktf_stack`	`cdktn.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`	`cdktn.TerraformProviderGeneratorMetadata`	No description.
`connection`	`cdktn.SSHProvisionerConnection \| cdktn.WinrmProvisionerConnection`	No description.
`count`	`typing.Union[int, float] \| cdktn.TerraformCount`	No description.
`depends_on`	`typing.List[str]`	No description.
`for_each`	`cdktn.ITerraformIterator`	No description.
`lifecycle`	`cdktn.TerraformResourceLifecycle`	No description.
`provider`	`cdktn.TerraformProvider`	No description.
`provisioners`	`typing.List[cdktn.FileProvisioner \| cdktn.LocalExecProvisioner \| cdktn.RemoteExecProvisioner]`	No description.
`timeouts`	`KmsCustomKeyStoreTimeoutsOutputReference`	No description.
`xks_proxy_authentication_credential`	`KmsCustomKeyStoreXksProxyAuthenticationCredentialOutputReference`	No description.
`cloud_hsm_cluster_id_input`	`str`	No description.
`custom_key_store_name_input`	`str`	No description.
`custom_key_store_type_input`	`str`	No description.
`id_input`	`str`	No description.
`key_store_password_input`	`str`	No description.
`region_input`	`str`	No description.
`timeouts_input`	`cdktn.IResolvable \| KmsCustomKeyStoreTimeouts`	No description.
`trust_anchor_certificate_input`	`str`	No description.
`xks_proxy_authentication_credential_input`	`KmsCustomKeyStoreXksProxyAuthenticationCredential`	No description.
`xks_proxy_connectivity_input`	`str`	No description.
`xks_proxy_uri_endpoint_input`	`str`	No description.
`xks_proxy_uri_path_input`	`str`	No description.
`xks_proxy_vpc_endpoint_service_name_input`	`str`	No description.
`cloud_hsm_cluster_id`	`str`	No description.
`custom_key_store_name`	`str`	No description.
`custom_key_store_type`	`str`	No description.
`id`	`str`	No description.
`key_store_password`	`str`	No description.
`region`	`str`	No description.
`trust_anchor_certificate`	`str`	No description.
`xks_proxy_connectivity`	`str`	No description.
`xks_proxy_uri_endpoint`	`str`	No description.
`xks_proxy_uri_path`	`str`	No description.
`xks_proxy_vpc_endpoint_service_name`	`str`	No description.

`node`^Required

node: Node

Type: constructs.Node

The tree node.

`cdktf_stack`^Required

cdktf_stack: TerraformStack

Type: cdktn.TerraformStack

`fqn`^Required

fqn: str

Type: str

`friendly_unique_id`^Required

friendly_unique_id: str

Type: str

`terraform_meta_arguments`^Required

terraform_meta_arguments: typing.Mapping[typing.Any]

Type: typing.Mapping[typing.Any]

`terraform_resource_type`^Required

terraform_resource_type: str

Type: str

`terraform_generator_metadata`^Optional

terraform_generator_metadata: TerraformProviderGeneratorMetadata

Type: cdktn.TerraformProviderGeneratorMetadata

`connection`^Optional

connection: SSHProvisionerConnection | WinrmProvisionerConnection

Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

`count`^Optional

count: typing.Union[int, float] | TerraformCount

Type: typing.Union[int, float] | cdktn.TerraformCount

`depends_on`^Optional

depends_on: typing.List[str]

Type: typing.List[str]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktn.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktn.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktn.TerraformProvider

`provisioners`^Optional

provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]

Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]

`timeouts`^Required

timeouts: KmsCustomKeyStoreTimeoutsOutputReference

Type: KmsCustomKeyStoreTimeoutsOutputReference

`xks_proxy_authentication_credential`^Required

xks_proxy_authentication_credential: KmsCustomKeyStoreXksProxyAuthenticationCredentialOutputReference

Type: KmsCustomKeyStoreXksProxyAuthenticationCredentialOutputReference

`cloud_hsm_cluster_id_input`^Optional

cloud_hsm_cluster_id_input: str

Type: str

`custom_key_store_name_input`^Optional

custom_key_store_name_input: str

Type: str

`custom_key_store_type_input`^Optional

custom_key_store_type_input: str

Type: str

`id_input`^Optional

id_input: str

Type: str

`key_store_password_input`^Optional

key_store_password_input: str

Type: str

`region_input`^Optional

region_input: str

Type: str

`timeouts_input`^Optional

timeouts_input: IResolvable | KmsCustomKeyStoreTimeouts

Type: cdktn.IResolvable | KmsCustomKeyStoreTimeouts

`trust_anchor_certificate_input`^Optional

trust_anchor_certificate_input: str

Type: str

`xks_proxy_authentication_credential_input`^Optional

xks_proxy_authentication_credential_input: KmsCustomKeyStoreXksProxyAuthenticationCredential

Type: KmsCustomKeyStoreXksProxyAuthenticationCredential

`xks_proxy_connectivity_input`^Optional

xks_proxy_connectivity_input: str

Type: str

`xks_proxy_uri_endpoint_input`^Optional

xks_proxy_uri_endpoint_input: str

Type: str

`xks_proxy_uri_path_input`^Optional

xks_proxy_uri_path_input: str

Type: str

`xks_proxy_vpc_endpoint_service_name_input`^Optional

xks_proxy_vpc_endpoint_service_name_input: str

Type: str

`cloud_hsm_cluster_id`^Required

cloud_hsm_cluster_id: str

Type: str

`custom_key_store_name`^Required

custom_key_store_name: str

Type: str

`custom_key_store_type`^Required

custom_key_store_type: str

Type: str

`id`^Required

id: str

Type: str

`key_store_password`^Required

key_store_password: str

Type: str

`region`^Required

region: str

Type: str

`trust_anchor_certificate`^Required

trust_anchor_certificate: str

Type: str

`xks_proxy_connectivity`^Required

xks_proxy_connectivity: str

Type: str

`xks_proxy_uri_endpoint`^Required

xks_proxy_uri_endpoint: str

Type: str

`xks_proxy_uri_path`^Required

xks_proxy_uri_path: str

Type: str

`xks_proxy_vpc_endpoint_service_name`^Required

xks_proxy_vpc_endpoint_service_name: str

Type: str

Constants

Name	Type	Description
`tfResourceType`	`str`	No description.

`tfResourceType`^Required

tfResourceType: str

Type: str

Structs

KmsCustomKeyStoreConfig

Initializer

from cdktn_provider_aws import kms_custom_key_store

kmsCustomKeyStore.KmsCustomKeyStoreConfig(
  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,
  custom_key_store_name: str,
  cloud_hsm_cluster_id: str = None,
  custom_key_store_type: str = None,
  id: str = None,
  key_store_password: str = None,
  region: str = None,
  timeouts: KmsCustomKeyStoreTimeouts = None,
  trust_anchor_certificate: str = None,
  xks_proxy_authentication_credential: KmsCustomKeyStoreXksProxyAuthenticationCredential = None,
  xks_proxy_connectivity: str = None,
  xks_proxy_uri_endpoint: str = None,
  xks_proxy_uri_path: str = None,
  xks_proxy_vpc_endpoint_service_name: str = None
)

Properties

Name	Type	Description
`connection`	`cdktn.SSHProvisionerConnection \| cdktn.WinrmProvisionerConnection`	No description.
`count`	`typing.Union[int, float] \| cdktn.TerraformCount`	No description.
`depends_on`	`typing.List[cdktn.ITerraformDependable]`	No description.
`for_each`	`cdktn.ITerraformIterator`	No description.
`lifecycle`	`cdktn.TerraformResourceLifecycle`	No description.
`provider`	`cdktn.TerraformProvider`	No description.
`provisioners`	`typing.List[cdktn.FileProvisioner \| cdktn.LocalExecProvisioner \| cdktn.RemoteExecProvisioner]`	No description.
`custom_key_store_name`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#custom_key_store_name KmsCustomKeyStore#custom_key_store_name}.
`cloud_hsm_cluster_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#cloud_hsm_cluster_id KmsCustomKeyStore#cloud_hsm_cluster_id}.
`custom_key_store_type`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#custom_key_store_type KmsCustomKeyStore#custom_key_store_type}.
`id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#id KmsCustomKeyStore#id}.
`key_store_password`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#key_store_password KmsCustomKeyStore#key_store_password}.
`region`	`str`	Region where this resource will be managed. Defaults to the Region set in the provider configuration.
`timeouts`	`KmsCustomKeyStoreTimeouts`	timeouts block.
`trust_anchor_certificate`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#trust_anchor_certificate KmsCustomKeyStore#trust_anchor_certificate}.
`xks_proxy_authentication_credential`	`KmsCustomKeyStoreXksProxyAuthenticationCredential`	xks_proxy_authentication_credential block.
`xks_proxy_connectivity`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#xks_proxy_connectivity KmsCustomKeyStore#xks_proxy_connectivity}.
`xks_proxy_uri_endpoint`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#xks_proxy_uri_endpoint KmsCustomKeyStore#xks_proxy_uri_endpoint}.
`xks_proxy_uri_path`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#xks_proxy_uri_path KmsCustomKeyStore#xks_proxy_uri_path}.
`xks_proxy_vpc_endpoint_service_name`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#xks_proxy_vpc_endpoint_service_name KmsCustomKeyStore#xks_proxy_vpc_endpoint_service_name}.

`connection`^Optional

connection: SSHProvisionerConnection | WinrmProvisionerConnection

Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

`count`^Optional

count: typing.Union[int, float] | TerraformCount

Type: typing.Union[int, float] | cdktn.TerraformCount

`depends_on`^Optional

depends_on: typing.List[ITerraformDependable]

Type: typing.List[cdktn.ITerraformDependable]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktn.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktn.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktn.TerraformProvider

`provisioners`^Optional

provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]

Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]

`custom_key_store_name`^Required

custom_key_store_name: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#custom_key_store_name KmsCustomKeyStore#custom_key_store_name}.

`cloud_hsm_cluster_id`^Optional

cloud_hsm_cluster_id: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#cloud_hsm_cluster_id KmsCustomKeyStore#cloud_hsm_cluster_id}.

`custom_key_store_type`^Optional

custom_key_store_type: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#custom_key_store_type KmsCustomKeyStore#custom_key_store_type}.

`id`^Optional

id: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#id KmsCustomKeyStore#id}.

`key_store_password`^Optional

key_store_password: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#key_store_password KmsCustomKeyStore#key_store_password}.

`region`^Optional

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.50.0/docs/resources/kms_custom_key_store#region KmsCustomKeyStore#region}

`timeouts`^Optional

timeouts: KmsCustomKeyStoreTimeouts

Type: KmsCustomKeyStoreTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#timeouts KmsCustomKeyStore#timeouts}

`trust_anchor_certificate`^Optional

trust_anchor_certificate: str

Type: str

`xks_proxy_authentication_credential`^Optional

xks_proxy_authentication_credential: KmsCustomKeyStoreXksProxyAuthenticationCredential

Type: KmsCustomKeyStoreXksProxyAuthenticationCredential

xks_proxy_authentication_credential block.

`xks_proxy_connectivity`^Optional

xks_proxy_connectivity: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#xks_proxy_connectivity KmsCustomKeyStore#xks_proxy_connectivity}.

`xks_proxy_uri_endpoint`^Optional

xks_proxy_uri_endpoint: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#xks_proxy_uri_endpoint KmsCustomKeyStore#xks_proxy_uri_endpoint}.

`xks_proxy_uri_path`^Optional

xks_proxy_uri_path: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#xks_proxy_uri_path KmsCustomKeyStore#xks_proxy_uri_path}.

`xks_proxy_vpc_endpoint_service_name`^Optional

xks_proxy_vpc_endpoint_service_name: str

Type: str

KmsCustomKeyStoreTimeouts

Initializer

from cdktn_provider_aws import kms_custom_key_store

kmsCustomKeyStore.KmsCustomKeyStoreTimeouts(
  create: str = None,
  delete: str = None,
  update: str = None
)

Properties

Name	Type	Description
`create`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#create KmsCustomKeyStore#create}.
`delete`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#delete KmsCustomKeyStore#delete}.
`update`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#update KmsCustomKeyStore#update}.

`create`^Optional

create: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#create KmsCustomKeyStore#create}.

`delete`^Optional

delete: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#delete KmsCustomKeyStore#delete}.

`update`^Optional

update: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#update KmsCustomKeyStore#update}.

KmsCustomKeyStoreXksProxyAuthenticationCredential

Initializer

from cdktn_provider_aws import kms_custom_key_store

kmsCustomKeyStore.KmsCustomKeyStoreXksProxyAuthenticationCredential(
  access_key_id: str,
  raw_secret_access_key: str
)

Properties

Name	Type	Description
`access_key_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#access_key_id KmsCustomKeyStore#access_key_id}.
`raw_secret_access_key`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#raw_secret_access_key KmsCustomKeyStore#raw_secret_access_key}.

`access_key_id`^Required

access_key_id: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#access_key_id KmsCustomKeyStore#access_key_id}.

`raw_secret_access_key`^Required

raw_secret_access_key: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/kms_custom_key_store#raw_secret_access_key KmsCustomKeyStore#raw_secret_access_key}.

Classes

KmsCustomKeyStoreTimeoutsOutputReference

Initializers

from cdktn_provider_aws import kms_custom_key_store

kmsCustomKeyStore.KmsCustomKeyStoreTimeoutsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)

Name	Type	Description
`terraform_resource`	`cdktn.IInterpolatingParent`	The parent resource.
`terraform_attribute`	`str`	The attribute on the parent resource this class is referencing.

`terraform_resource`^Required

Type: cdktn.IInterpolatingParent

The parent resource.

`terraform_attribute`^Required

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.
`reset_delete`	No description.
`reset_update`	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_attribute`^Required

Type: str

`get_boolean_attribute`

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`get_boolean_map_attribute`

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

`terraform_attribute`^Required

Type: str

`get_list_attribute`

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

`terraform_attribute`^Required

Type: str

`get_number_attribute`

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

`terraform_attribute`^Required

Type: str

`get_number_list_attribute`

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_number_map_attribute`

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_string_attribute`

def get_string_attribute(
  terraform_attribute: str
) -> str

`terraform_attribute`^Required

Type: str

`get_string_map_attribute`

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

`terraform_attribute`^Required

Type: str

`interpolation_for_attribute`

def interpolation_for_attribute(
  property: str
) -> IResolvable

`property`^Required

Type: str

`resolve`

def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktn.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

`reset_delete`

def reset_delete() -> None

`reset_update`

def reset_update() -> 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.
`delete_input`	`str`	No description.
`update_input`	`str`	No description.
`create`	`str`	No description.
`delete`	`str`	No description.
`update`	`str`	No description.
`internal_value`	`cdktn.IResolvable \| KmsCustomKeyStoreTimeouts`	No description.

`creation_stack`^Required

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.

`fqn`^Required

fqn: str

Type: str

`create_input`^Optional

create_input: str

Type: str

`delete_input`^Optional

delete_input: str

Type: str

`update_input`^Optional

update_input: str

Type: str

`create`^Required

create: str

Type: str

`delete`^Required

delete: str

Type: str

`update`^Required

update: str

Type: str

`internal_value`^Optional

internal_value: IResolvable | KmsCustomKeyStoreTimeouts

Type: cdktn.IResolvable | KmsCustomKeyStoreTimeouts

KmsCustomKeyStoreXksProxyAuthenticationCredentialOutputReference

Initializers

from cdktn_provider_aws import kms_custom_key_store

kmsCustomKeyStore.KmsCustomKeyStoreXksProxyAuthenticationCredentialOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)

Name	Type	Description
`terraform_resource`	`cdktn.IInterpolatingParent`	The parent resource.
`terraform_attribute`	`str`	The attribute on the parent resource this class is referencing.

`terraform_resource`^Required

Type: cdktn.IInterpolatingParent

The parent resource.

`terraform_attribute`^Required

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.

`compute_fqn`

def compute_fqn() -> str

`get_any_map_attribute`

def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]

`terraform_attribute`^Required

Type: str

`get_boolean_attribute`

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`get_boolean_map_attribute`

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

`terraform_attribute`^Required

Type: str

`get_list_attribute`

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

`terraform_attribute`^Required

Type: str

`get_number_attribute`

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

`terraform_attribute`^Required

Type: str

`get_number_list_attribute`

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_number_map_attribute`

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_string_attribute`

def get_string_attribute(
  terraform_attribute: str
) -> str

`terraform_attribute`^Required

Type: str

`get_string_map_attribute`

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

`terraform_attribute`^Required

Type: str

`interpolation_for_attribute`

def interpolation_for_attribute(
  property: str
) -> IResolvable

`property`^Required

Type: str

`resolve`

def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktn.IResolveContext

`to_string`

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

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.
`access_key_id_input`	`str`	No description.
`raw_secret_access_key_input`	`str`	No description.
`access_key_id`	`str`	No description.
`raw_secret_access_key`	`str`	No description.
`internal_value`	`KmsCustomKeyStoreXksProxyAuthenticationCredential`	No description.

`creation_stack`^Required

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.

`fqn`^Required

fqn: str

Type: str

`access_key_id_input`^Optional

access_key_id_input: str

Type: str

`raw_secret_access_key_input`^Optional

raw_secret_access_key_input: str

Type: str

`access_key_id`^Required

access_key_id: str

Type: str

`raw_secret_access_key`^Required

raw_secret_access_key: str

Type: str

`internal_value`^Optional

internal_value: KmsCustomKeyStoreXksProxyAuthenticationCredential

Type: KmsCustomKeyStoreXksProxyAuthenticationCredential

FilesExpand file tree

kmsCustomKeyStore.python.md

Latest commit

History

kmsCustomKeyStore.python.md

File metadata and controls

kmsCustomKeyStore Submodule

Constructs