Skip to content

Latest commit

 

History

History
2530 lines (1618 loc) · 117 KB

File metadata and controls

2530 lines (1618 loc) · 117 KB

docdbClusterInstance Submodule

Constructs

DocdbClusterInstance

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

Initializers

from cdktn_provider_aws import docdb_cluster_instance

docdbClusterInstance.DocdbClusterInstance(
  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,
  cluster_identifier: str,
  instance_class: str,
  apply_immediately: bool | IResolvable = None,
  auto_minor_version_upgrade: bool | IResolvable = None,
  availability_zone: str = None,
  ca_cert_identifier: str = None,
  certificate_rotation_restart: str = None,
  copy_tags_to_snapshot: bool | IResolvable = None,
  enable_performance_insights: bool | IResolvable = None,
  engine: str = None,
  id: str = None,
  identifier: str = None,
  identifier_prefix: str = None,
  performance_insights_kms_key_id: str = None,
  preferred_maintenance_window: str = None,
  promotion_tier: typing.Union[int, float] = None,
  region: str = None,
  tags: typing.Mapping[str] = None,
  tags_all: typing.Mapping[str] = None,
  timeouts: DocdbClusterInstanceTimeouts = 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.
cluster_identifier str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#cluster_identifier DocdbClusterInstance#cluster_identifier}.
instance_class str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#instance_class DocdbClusterInstance#instance_class}.
apply_immediately bool | cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#apply_immediately DocdbClusterInstance#apply_immediately}.
auto_minor_version_upgrade bool | cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#auto_minor_version_upgrade DocdbClusterInstance#auto_minor_version_upgrade}.
availability_zone str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#availability_zone DocdbClusterInstance#availability_zone}.
ca_cert_identifier str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#ca_cert_identifier DocdbClusterInstance#ca_cert_identifier}.
certificate_rotation_restart str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#certificate_rotation_restart DocdbClusterInstance#certificate_rotation_restart}.
copy_tags_to_snapshot bool | cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#copy_tags_to_snapshot DocdbClusterInstance#copy_tags_to_snapshot}.
enable_performance_insights bool | cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#enable_performance_insights DocdbClusterInstance#enable_performance_insights}.
engine str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#engine DocdbClusterInstance#engine}.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#id DocdbClusterInstance#id}.
identifier str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#identifier DocdbClusterInstance#identifier}.
identifier_prefix str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#identifier_prefix DocdbClusterInstance#identifier_prefix}.
performance_insights_kms_key_id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#performance_insights_kms_key_id DocdbClusterInstance#performance_insights_kms_key_id}.
preferred_maintenance_window str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#preferred_maintenance_window DocdbClusterInstance#preferred_maintenance_window}.
promotion_tier typing.Union[int, float] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#promotion_tier DocdbClusterInstance#promotion_tier}.
region str Region where this resource will be managed. Defaults to the Region set in the provider configuration.
tags typing.Mapping[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#tags DocdbClusterInstance#tags}.
tags_all typing.Mapping[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#tags_all DocdbClusterInstance#tags_all}.
timeouts DocdbClusterInstanceTimeouts timeouts block.

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: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

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

depends_onOptional
  • Type: typing.List[cdktn.ITerraformDependable]

for_eachOptional
  • Type: cdktn.ITerraformIterator

lifecycleOptional
  • Type: cdktn.TerraformResourceLifecycle

providerOptional
  • Type: cdktn.TerraformProvider

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

cluster_identifierRequired
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#cluster_identifier DocdbClusterInstance#cluster_identifier}.


instance_classRequired
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#instance_class DocdbClusterInstance#instance_class}.


apply_immediatelyOptional
  • Type: bool | cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#apply_immediately DocdbClusterInstance#apply_immediately}.


auto_minor_version_upgradeOptional
  • Type: bool | cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#auto_minor_version_upgrade DocdbClusterInstance#auto_minor_version_upgrade}.


availability_zoneOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#availability_zone DocdbClusterInstance#availability_zone}.


ca_cert_identifierOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#ca_cert_identifier DocdbClusterInstance#ca_cert_identifier}.


certificate_rotation_restartOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#certificate_rotation_restart DocdbClusterInstance#certificate_rotation_restart}.


copy_tags_to_snapshotOptional
  • Type: bool | cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#copy_tags_to_snapshot DocdbClusterInstance#copy_tags_to_snapshot}.


enable_performance_insightsOptional
  • Type: bool | cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#enable_performance_insights DocdbClusterInstance#enable_performance_insights}.


engineOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#engine DocdbClusterInstance#engine}.


idOptional
  • Type: str

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


identifierOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#identifier DocdbClusterInstance#identifier}.


identifier_prefixOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#identifier_prefix DocdbClusterInstance#identifier_prefix}.


performance_insights_kms_key_idOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#performance_insights_kms_key_id DocdbClusterInstance#performance_insights_kms_key_id}.


preferred_maintenance_windowOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#preferred_maintenance_window DocdbClusterInstance#preferred_maintenance_window}.


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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#promotion_tier DocdbClusterInstance#promotion_tier}.


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


tagsOptional
  • Type: typing.Mapping[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#tags DocdbClusterInstance#tags}.


tags_allOptional
  • Type: typing.Mapping[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#tags_all DocdbClusterInstance#tags_all}.


timeoutsOptional

timeouts block.

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


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.
reset_apply_immediately No description.
reset_auto_minor_version_upgrade No description.
reset_availability_zone No description.
reset_ca_cert_identifier No description.
reset_certificate_rotation_restart No description.
reset_copy_tags_to_snapshot No description.
reset_enable_performance_insights No description.
reset_engine No description.
reset_id No description.
reset_identifier No description.
reset_identifier_prefix No description.
reset_performance_insights_kms_key_id No description.
reset_preferred_maintenance_window No description.
reset_promotion_tier No description.
reset_region No description.
reset_tags No description.
reset_tags_all No description.
reset_timeouts 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.

mixinsRequired
  • Type: *constructs.IMixin

The mixins to apply.


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: cdktn.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,
  delete: str = None,
  update: str = None
) -> None
createOptional
  • Type: str

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


deleteOptional
  • Type: str

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


updateOptional
  • Type: str

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


reset_apply_immediately
def reset_apply_immediately() -> None
reset_auto_minor_version_upgrade
def reset_auto_minor_version_upgrade() -> None
reset_availability_zone
def reset_availability_zone() -> None
reset_ca_cert_identifier
def reset_ca_cert_identifier() -> None
reset_certificate_rotation_restart
def reset_certificate_rotation_restart() -> None
reset_copy_tags_to_snapshot
def reset_copy_tags_to_snapshot() -> None
reset_enable_performance_insights
def reset_enable_performance_insights() -> None
reset_engine
def reset_engine() -> None
reset_id
def reset_id() -> None
reset_identifier
def reset_identifier() -> None
reset_identifier_prefix
def reset_identifier_prefix() -> None
reset_performance_insights_kms_key_id
def reset_performance_insights_kms_key_id() -> None
reset_preferred_maintenance_window
def reset_preferred_maintenance_window() -> None
reset_promotion_tier
def reset_promotion_tier() -> None
reset_region
def reset_region() -> None
reset_tags
def reset_tags() -> None
reset_tags_all
def reset_tags_all() -> None
reset_timeouts
def reset_timeouts() -> 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 DocdbClusterInstance resource upon running "cdktn plan ".

is_construct
from cdktn_provider_aws import docdb_cluster_instance

docdbClusterInstance.DocdbClusterInstance.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 cdktn_provider_aws import docdb_cluster_instance

docdbClusterInstance.DocdbClusterInstance.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any

is_terraform_resource
from cdktn_provider_aws import docdb_cluster_instance

docdbClusterInstance.DocdbClusterInstance.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any

generate_config_for_import
from cdktn_provider_aws import docdb_cluster_instance

docdbClusterInstance.DocdbClusterInstance.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

Generates CDKTN code for importing a DocdbClusterInstance resource upon running "cdktn 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 DocdbClusterInstance to import.


import_from_idRequired
  • Type: str

The id of the existing DocdbClusterInstance that should be imported.

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


providerOptional
  • Type: cdktn.TerraformProvider

? Optional instance of the provider where the DocdbClusterInstance 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.
arn str No description.
dbi_resource_id str No description.
db_subnet_group_name str No description.
endpoint str No description.
engine_version str No description.
kms_key_id str No description.
port typing.Union[int, float] No description.
preferred_backup_window str No description.
publicly_accessible cdktn.IResolvable No description.
storage_encrypted cdktn.IResolvable No description.
timeouts DocdbClusterInstanceTimeoutsOutputReference No description.
writer cdktn.IResolvable No description.
apply_immediately_input bool | cdktn.IResolvable No description.
auto_minor_version_upgrade_input bool | cdktn.IResolvable No description.
availability_zone_input str No description.
ca_cert_identifier_input str No description.
certificate_rotation_restart_input str No description.
cluster_identifier_input str No description.
copy_tags_to_snapshot_input bool | cdktn.IResolvable No description.
enable_performance_insights_input bool | cdktn.IResolvable No description.
engine_input str No description.
identifier_input str No description.
identifier_prefix_input str No description.
id_input str No description.
instance_class_input str No description.
performance_insights_kms_key_id_input str No description.
preferred_maintenance_window_input str No description.
promotion_tier_input typing.Union[int, float] No description.
region_input str No description.
tags_all_input typing.Mapping[str] No description.
tags_input typing.Mapping[str] No description.
timeouts_input cdktn.IResolvable | DocdbClusterInstanceTimeouts No description.
apply_immediately bool | cdktn.IResolvable No description.
auto_minor_version_upgrade bool | cdktn.IResolvable No description.
availability_zone str No description.
ca_cert_identifier str No description.
certificate_rotation_restart str No description.
cluster_identifier str No description.
copy_tags_to_snapshot bool | cdktn.IResolvable No description.
enable_performance_insights bool | cdktn.IResolvable No description.
engine str No description.
id str No description.
identifier str No description.
identifier_prefix str No description.
instance_class str No description.
performance_insights_kms_key_id str No description.
preferred_maintenance_window str No description.
promotion_tier typing.Union[int, float] No description.
region str No description.
tags typing.Mapping[str] No description.
tags_all typing.Mapping[str] No description.

nodeRequired
node: Node
  • Type: constructs.Node

The tree node.


cdktf_stackRequired
cdktf_stack: TerraformStack
  • Type: cdktn.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: cdktn.TerraformProviderGeneratorMetadata

connectionOptional
connection: SSHProvisionerConnection | WinrmProvisionerConnection
  • Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

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

depends_onOptional
depends_on: typing.List[str]
  • Type: typing.List[str]

for_eachOptional
for_each: ITerraformIterator
  • Type: cdktn.ITerraformIterator

lifecycleOptional
lifecycle: TerraformResourceLifecycle
  • Type: cdktn.TerraformResourceLifecycle

providerOptional
provider: TerraformProvider
  • Type: cdktn.TerraformProvider

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

arnRequired
arn: str
  • Type: str

dbi_resource_idRequired
dbi_resource_id: str
  • Type: str

db_subnet_group_nameRequired
db_subnet_group_name: str
  • Type: str

endpointRequired
endpoint: str
  • Type: str

engine_versionRequired
engine_version: str
  • Type: str

kms_key_idRequired
kms_key_id: str
  • Type: str

portRequired
port: typing.Union[int, float]
  • Type: typing.Union[int, float]

preferred_backup_windowRequired
preferred_backup_window: str
  • Type: str

publicly_accessibleRequired
publicly_accessible: IResolvable
  • Type: cdktn.IResolvable

storage_encryptedRequired
storage_encrypted: IResolvable
  • Type: cdktn.IResolvable

timeoutsRequired
timeouts: DocdbClusterInstanceTimeoutsOutputReference

writerRequired
writer: IResolvable
  • Type: cdktn.IResolvable

apply_immediately_inputOptional
apply_immediately_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable

auto_minor_version_upgrade_inputOptional
auto_minor_version_upgrade_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable

availability_zone_inputOptional
availability_zone_input: str
  • Type: str

ca_cert_identifier_inputOptional
ca_cert_identifier_input: str
  • Type: str

certificate_rotation_restart_inputOptional
certificate_rotation_restart_input: str
  • Type: str

cluster_identifier_inputOptional
cluster_identifier_input: str
  • Type: str

copy_tags_to_snapshot_inputOptional
copy_tags_to_snapshot_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable

enable_performance_insights_inputOptional
enable_performance_insights_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable

engine_inputOptional
engine_input: str
  • Type: str

identifier_inputOptional
identifier_input: str
  • Type: str

identifier_prefix_inputOptional
identifier_prefix_input: str
  • Type: str

id_inputOptional
id_input: str
  • Type: str

instance_class_inputOptional
instance_class_input: str
  • Type: str

performance_insights_kms_key_id_inputOptional
performance_insights_kms_key_id_input: str
  • Type: str

preferred_maintenance_window_inputOptional
preferred_maintenance_window_input: str
  • Type: str

promotion_tier_inputOptional
promotion_tier_input: typing.Union[int, float]
  • Type: typing.Union[int, float]

region_inputOptional
region_input: str
  • Type: str

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 | DocdbClusterInstanceTimeouts

apply_immediatelyRequired
apply_immediately: bool | IResolvable
  • Type: bool | cdktn.IResolvable

auto_minor_version_upgradeRequired
auto_minor_version_upgrade: bool | IResolvable
  • Type: bool | cdktn.IResolvable

availability_zoneRequired
availability_zone: str
  • Type: str

ca_cert_identifierRequired
ca_cert_identifier: str
  • Type: str

certificate_rotation_restartRequired
certificate_rotation_restart: str
  • Type: str

cluster_identifierRequired
cluster_identifier: str
  • Type: str

copy_tags_to_snapshotRequired
copy_tags_to_snapshot: bool | IResolvable
  • Type: bool | cdktn.IResolvable

enable_performance_insightsRequired
enable_performance_insights: bool | IResolvable
  • Type: bool | cdktn.IResolvable

engineRequired
engine: str
  • Type: str

idRequired
id: str
  • Type: str

identifierRequired
identifier: str
  • Type: str

identifier_prefixRequired
identifier_prefix: str
  • Type: str

instance_classRequired
instance_class: str
  • Type: str

performance_insights_kms_key_idRequired
performance_insights_kms_key_id: str
  • Type: str

preferred_maintenance_windowRequired
preferred_maintenance_window: str
  • Type: str

promotion_tierRequired
promotion_tier: typing.Union[int, float]
  • Type: typing.Union[int, float]

regionRequired
region: str
  • Type: str

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

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

Constants

Name Type Description
tfResourceType str No description.

tfResourceTypeRequired
tfResourceType: str
  • Type: str

Structs

DocdbClusterInstanceConfig

Initializer

from cdktn_provider_aws import docdb_cluster_instance

docdbClusterInstance.DocdbClusterInstanceConfig(
  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,
  cluster_identifier: str,
  instance_class: str,
  apply_immediately: bool | IResolvable = None,
  auto_minor_version_upgrade: bool | IResolvable = None,
  availability_zone: str = None,
  ca_cert_identifier: str = None,
  certificate_rotation_restart: str = None,
  copy_tags_to_snapshot: bool | IResolvable = None,
  enable_performance_insights: bool | IResolvable = None,
  engine: str = None,
  id: str = None,
  identifier: str = None,
  identifier_prefix: str = None,
  performance_insights_kms_key_id: str = None,
  preferred_maintenance_window: str = None,
  promotion_tier: typing.Union[int, float] = None,
  region: str = None,
  tags: typing.Mapping[str] = None,
  tags_all: typing.Mapping[str] = None,
  timeouts: DocdbClusterInstanceTimeouts = 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.
cluster_identifier str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#cluster_identifier DocdbClusterInstance#cluster_identifier}.
instance_class str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#instance_class DocdbClusterInstance#instance_class}.
apply_immediately bool | cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#apply_immediately DocdbClusterInstance#apply_immediately}.
auto_minor_version_upgrade bool | cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#auto_minor_version_upgrade DocdbClusterInstance#auto_minor_version_upgrade}.
availability_zone str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#availability_zone DocdbClusterInstance#availability_zone}.
ca_cert_identifier str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#ca_cert_identifier DocdbClusterInstance#ca_cert_identifier}.
certificate_rotation_restart str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#certificate_rotation_restart DocdbClusterInstance#certificate_rotation_restart}.
copy_tags_to_snapshot bool | cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#copy_tags_to_snapshot DocdbClusterInstance#copy_tags_to_snapshot}.
enable_performance_insights bool | cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#enable_performance_insights DocdbClusterInstance#enable_performance_insights}.
engine str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#engine DocdbClusterInstance#engine}.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#id DocdbClusterInstance#id}.
identifier str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#identifier DocdbClusterInstance#identifier}.
identifier_prefix str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#identifier_prefix DocdbClusterInstance#identifier_prefix}.
performance_insights_kms_key_id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#performance_insights_kms_key_id DocdbClusterInstance#performance_insights_kms_key_id}.
preferred_maintenance_window str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#preferred_maintenance_window DocdbClusterInstance#preferred_maintenance_window}.
promotion_tier typing.Union[int, float] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#promotion_tier DocdbClusterInstance#promotion_tier}.
region str Region where this resource will be managed. Defaults to the Region set in the provider configuration.
tags typing.Mapping[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#tags DocdbClusterInstance#tags}.
tags_all typing.Mapping[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#tags_all DocdbClusterInstance#tags_all}.
timeouts DocdbClusterInstanceTimeouts timeouts block.

connectionOptional
connection: SSHProvisionerConnection | WinrmProvisionerConnection
  • Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

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

depends_onOptional
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktn.ITerraformDependable]

for_eachOptional
for_each: ITerraformIterator
  • Type: cdktn.ITerraformIterator

lifecycleOptional
lifecycle: TerraformResourceLifecycle
  • Type: cdktn.TerraformResourceLifecycle

providerOptional
provider: TerraformProvider
  • Type: cdktn.TerraformProvider

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

cluster_identifierRequired
cluster_identifier: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#cluster_identifier DocdbClusterInstance#cluster_identifier}.


instance_classRequired
instance_class: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#instance_class DocdbClusterInstance#instance_class}.


apply_immediatelyOptional
apply_immediately: bool | IResolvable
  • Type: bool | cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#apply_immediately DocdbClusterInstance#apply_immediately}.


auto_minor_version_upgradeOptional
auto_minor_version_upgrade: bool | IResolvable
  • Type: bool | cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#auto_minor_version_upgrade DocdbClusterInstance#auto_minor_version_upgrade}.


availability_zoneOptional
availability_zone: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#availability_zone DocdbClusterInstance#availability_zone}.


ca_cert_identifierOptional
ca_cert_identifier: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#ca_cert_identifier DocdbClusterInstance#ca_cert_identifier}.


certificate_rotation_restartOptional
certificate_rotation_restart: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#certificate_rotation_restart DocdbClusterInstance#certificate_rotation_restart}.


copy_tags_to_snapshotOptional
copy_tags_to_snapshot: bool | IResolvable
  • Type: bool | cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#copy_tags_to_snapshot DocdbClusterInstance#copy_tags_to_snapshot}.


enable_performance_insightsOptional
enable_performance_insights: bool | IResolvable
  • Type: bool | cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#enable_performance_insights DocdbClusterInstance#enable_performance_insights}.


engineOptional
engine: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#engine DocdbClusterInstance#engine}.


idOptional
id: str
  • Type: str

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


identifierOptional
identifier: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#identifier DocdbClusterInstance#identifier}.


identifier_prefixOptional
identifier_prefix: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#identifier_prefix DocdbClusterInstance#identifier_prefix}.


performance_insights_kms_key_idOptional
performance_insights_kms_key_id: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#performance_insights_kms_key_id DocdbClusterInstance#performance_insights_kms_key_id}.


preferred_maintenance_windowOptional
preferred_maintenance_window: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#preferred_maintenance_window DocdbClusterInstance#preferred_maintenance_window}.


promotion_tierOptional
promotion_tier: typing.Union[int, float]
  • Type: typing.Union[int, float]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#promotion_tier DocdbClusterInstance#promotion_tier}.


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


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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#tags DocdbClusterInstance#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.50.0/docs/resources/docdb_cluster_instance#tags_all DocdbClusterInstance#tags_all}.


timeoutsOptional
timeouts: DocdbClusterInstanceTimeouts

timeouts block.

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


DocdbClusterInstanceTimeouts

Initializer

from cdktn_provider_aws import docdb_cluster_instance

docdbClusterInstance.DocdbClusterInstanceTimeouts(
  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/docdb_cluster_instance#create DocdbClusterInstance#create}.
delete str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#delete DocdbClusterInstance#delete}.
update str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#update DocdbClusterInstance#update}.

createOptional
create: str
  • Type: str

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


deleteOptional
delete: str
  • Type: str

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


updateOptional
update: str
  • Type: str

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


Classes

DocdbClusterInstanceTimeoutsOutputReference

Initializers

from cdktn_provider_aws import docdb_cluster_instance

docdbClusterInstance.DocdbClusterInstanceTimeoutsOutputReference(
  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_resourceRequired
  • Type: cdktn.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.
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_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: 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 | DocdbClusterInstanceTimeouts 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

delete_inputOptional
delete_input: str
  • Type: str

update_inputOptional
update_input: str
  • Type: str

createRequired
create: str
  • Type: str

deleteRequired
delete: str
  • Type: str

updateRequired
update: str
  • Type: str

internal_valueOptional
internal_value: IResolvable | DocdbClusterInstanceTimeouts