docdbCluster.md

aws_docdb_cluster

Refer to the Terraform Registory for docs: aws_docdb_cluster.

docdbCluster Submodule

Constructs

DocdbCluster

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

Initializers

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

new docdbCluster.DocdbCluster(scope: Construct, id: string, config?: DocdbClusterConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	DocdbClusterConfig	No description.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

config^Optional

• Type: DocdbClusterConfig

---

Methods

Name	Description
toString	Returns a string representation of this construct.
addOverride	No description.
overrideLogicalId	Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId	Resets a previously passed logical Id to use the auto-generated logical id again.
toMetadata	No description.
toTerraform	Adds this resource to the terraform JSON output.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
interpolationForAttribute	No description.
putTimeouts	No description.
resetApplyImmediately	No description.
resetAvailabilityZones	No description.
resetBackupRetentionPeriod	No description.
resetClusterIdentifier	No description.
resetClusterIdentifierPrefix	No description.
resetClusterMembers	No description.
resetDbClusterParameterGroupName	No description.
resetDbSubnetGroupName	No description.
resetDeletionProtection	No description.
resetEnabledCloudwatchLogsExports	No description.
resetEngine	No description.
resetEngineVersion	No description.
resetFinalSnapshotIdentifier	No description.
resetGlobalClusterIdentifier	No description.
resetId	No description.
resetKmsKeyId	No description.
resetMasterPassword	No description.
resetMasterUsername	No description.
resetPort	No description.
resetPreferredBackupWindow	No description.
resetPreferredMaintenanceWindow	No description.
resetSkipFinalSnapshot	No description.
resetSnapshotIdentifier	No description.
resetStorageEncrypted	No description.
resetTags	No description.
resetTagsAll	No description.
resetTimeouts	No description.
resetVpcSecurityGroupIds	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

addOverride

public addOverride(path: string, value: any): void

path^Required

• Type: string

---

value^Required

• Type: any

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

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

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

resetOverrideLogicalId

public resetOverrideLogicalId(): void

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

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

putTimeouts

public putTimeouts(value: DocdbClusterTimeouts): void

value^Required

• Type: DocdbClusterTimeouts

---

resetApplyImmediately

public resetApplyImmediately(): void

resetAvailabilityZones

public resetAvailabilityZones(): void

resetBackupRetentionPeriod

public resetBackupRetentionPeriod(): void

resetClusterIdentifier

public resetClusterIdentifier(): void

resetClusterIdentifierPrefix

public resetClusterIdentifierPrefix(): void

resetClusterMembers

public resetClusterMembers(): void

resetDbClusterParameterGroupName

public resetDbClusterParameterGroupName(): void

resetDbSubnetGroupName

public resetDbSubnetGroupName(): void

resetDeletionProtection

public resetDeletionProtection(): void

resetEnabledCloudwatchLogsExports

public resetEnabledCloudwatchLogsExports(): void

resetEngine

public resetEngine(): void

resetEngineVersion

public resetEngineVersion(): void

resetFinalSnapshotIdentifier

public resetFinalSnapshotIdentifier(): void

resetGlobalClusterIdentifier

public resetGlobalClusterIdentifier(): void

resetId

public resetId(): void

resetKmsKeyId

public resetKmsKeyId(): void

resetMasterPassword

public resetMasterPassword(): void

resetMasterUsername

public resetMasterUsername(): void

resetPort

public resetPort(): void

resetPreferredBackupWindow

public resetPreferredBackupWindow(): void

resetPreferredMaintenanceWindow

public resetPreferredMaintenanceWindow(): void

resetSkipFinalSnapshot

public resetSkipFinalSnapshot(): void

resetSnapshotIdentifier

public resetSnapshotIdentifier(): void

resetStorageEncrypted

public resetStorageEncrypted(): void

resetTags

public resetTags(): void

resetTagsAll

public resetTagsAll(): void

resetTimeouts

public resetTimeouts(): void

resetVpcSecurityGroupIds

public resetVpcSecurityGroupIds(): void

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isTerraformElement	No description.
isTerraformResource	No description.

---

isConstruct

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

docdbCluster.DocdbCluster.isConstruct(x: any)

Checks if x is a construct.

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

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

x^Required

• Type: any

Any object.

---

isTerraformElement

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

docdbCluster.DocdbCluster.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

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

docdbCluster.DocdbCluster.isTerraformResource(x: any)

x^Required

• Type: any

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
cdktfStack	cdktf.TerraformStack	No description.
fqn	string	No description.
friendlyUniqueId	string	No description.
terraformMetaArguments	{[ key: string ]: any}	No description.
terraformResourceType	string	No description.
terraformGeneratorMetadata	cdktf.TerraformProviderGeneratorMetadata	No description.
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	string[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
arn	string	No description.
clusterResourceId	string	No description.
endpoint	string	No description.
hostedZoneId	string	No description.
readerEndpoint	string	No description.
timeouts	DocdbClusterTimeoutsOutputReference	No description.
applyImmediatelyInput	boolean | cdktf.IResolvable	No description.
availabilityZonesInput	string[]	No description.
backupRetentionPeriodInput	number	No description.
clusterIdentifierInput	string	No description.
clusterIdentifierPrefixInput	string	No description.
clusterMembersInput	string[]	No description.
dbClusterParameterGroupNameInput	string	No description.
dbSubnetGroupNameInput	string	No description.
deletionProtectionInput	boolean | cdktf.IResolvable	No description.
enabledCloudwatchLogsExportsInput	string[]	No description.
engineInput	string	No description.
engineVersionInput	string	No description.
finalSnapshotIdentifierInput	string	No description.
globalClusterIdentifierInput	string	No description.
idInput	string	No description.
kmsKeyIdInput	string	No description.
masterPasswordInput	string	No description.
masterUsernameInput	string	No description.
portInput	number	No description.
preferredBackupWindowInput	string	No description.
preferredMaintenanceWindowInput	string	No description.
skipFinalSnapshotInput	boolean | cdktf.IResolvable	No description.
snapshotIdentifierInput	string	No description.
storageEncryptedInput	boolean | cdktf.IResolvable	No description.
tagsAllInput	{[ key: string ]: string}	No description.
tagsInput	{[ key: string ]: string}	No description.
timeoutsInput	cdktf.IResolvable | DocdbClusterTimeouts	No description.
vpcSecurityGroupIdsInput	string[]	No description.
applyImmediately	boolean | cdktf.IResolvable	No description.
availabilityZones	string[]	No description.
backupRetentionPeriod	number	No description.
clusterIdentifier	string	No description.
clusterIdentifierPrefix	string	No description.
clusterMembers	string[]	No description.
dbClusterParameterGroupName	string	No description.
dbSubnetGroupName	string	No description.
deletionProtection	boolean | cdktf.IResolvable	No description.
enabledCloudwatchLogsExports	string[]	No description.
engine	string	No description.
engineVersion	string	No description.
finalSnapshotIdentifier	string	No description.
globalClusterIdentifier	string	No description.
id	string	No description.
kmsKeyId	string	No description.
masterPassword	string	No description.
masterUsername	string	No description.
port	number	No description.
preferredBackupWindow	string	No description.
preferredMaintenanceWindow	string	No description.
skipFinalSnapshot	boolean | cdktf.IResolvable	No description.
snapshotIdentifier	string	No description.
storageEncrypted	boolean | cdktf.IResolvable	No description.
tags	{[ key: string ]: string}	No description.
tagsAll	{[ key: string ]: string}	No description.
vpcSecurityGroupIds	string[]	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktf.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

terraformMetaArguments^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktf.TerraformProviderGeneratorMetadata

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

arn^Required

public readonly arn: string;

• Type: string

---

clusterResourceId^Required

public readonly clusterResourceId: string;

• Type: string

---

endpoint^Required

public readonly endpoint: string;

• Type: string

---

hostedZoneId^Required

public readonly hostedZoneId: string;

• Type: string

---

readerEndpoint^Required

public readonly readerEndpoint: string;

• Type: string

---

timeouts^Required

public readonly timeouts: DocdbClusterTimeoutsOutputReference;

• Type: DocdbClusterTimeoutsOutputReference

---

applyImmediatelyInput^Optional

public readonly applyImmediatelyInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

availabilityZonesInput^Optional

public readonly availabilityZonesInput: string[];

• Type: string[]

---

backupRetentionPeriodInput^Optional

public readonly backupRetentionPeriodInput: number;

• Type: number

---

clusterIdentifierInput^Optional

public readonly clusterIdentifierInput: string;

• Type: string

---

clusterIdentifierPrefixInput^Optional

public readonly clusterIdentifierPrefixInput: string;

• Type: string

---

clusterMembersInput^Optional

public readonly clusterMembersInput: string[];

• Type: string[]

---

dbClusterParameterGroupNameInput^Optional

public readonly dbClusterParameterGroupNameInput: string;

• Type: string

---

dbSubnetGroupNameInput^Optional

public readonly dbSubnetGroupNameInput: string;

• Type: string

---

deletionProtectionInput^Optional

public readonly deletionProtectionInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

enabledCloudwatchLogsExportsInput^Optional

public readonly enabledCloudwatchLogsExportsInput: string[];

• Type: string[]

---

engineInput^Optional

public readonly engineInput: string;

• Type: string

---

engineVersionInput^Optional

public readonly engineVersionInput: string;

• Type: string

---

finalSnapshotIdentifierInput^Optional

public readonly finalSnapshotIdentifierInput: string;

• Type: string

---

globalClusterIdentifierInput^Optional

public readonly globalClusterIdentifierInput: string;

• Type: string

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

kmsKeyIdInput^Optional

public readonly kmsKeyIdInput: string;

• Type: string

---

masterPasswordInput^Optional

public readonly masterPasswordInput: string;

• Type: string

---

masterUsernameInput^Optional

public readonly masterUsernameInput: string;

• Type: string

---

portInput^Optional

public readonly portInput: number;

• Type: number

---

preferredBackupWindowInput^Optional

public readonly preferredBackupWindowInput: string;

• Type: string

---

preferredMaintenanceWindowInput^Optional

public readonly preferredMaintenanceWindowInput: string;

• Type: string

---

skipFinalSnapshotInput^Optional

public readonly skipFinalSnapshotInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

snapshotIdentifierInput^Optional

public readonly snapshotIdentifierInput: string;

• Type: string

---

storageEncryptedInput^Optional

public readonly storageEncryptedInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

tagsAllInput^Optional

public readonly tagsAllInput: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

tagsInput^Optional

public readonly tagsInput: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

timeoutsInput^Optional

public readonly timeoutsInput: IResolvable | DocdbClusterTimeouts;

• Type: cdktf.IResolvable | DocdbClusterTimeouts

---

vpcSecurityGroupIdsInput^Optional

public readonly vpcSecurityGroupIdsInput: string[];

• Type: string[]

---

applyImmediately^Required

public readonly applyImmediately: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

availabilityZones^Required

public readonly availabilityZones: string[];

• Type: string[]

---

backupRetentionPeriod^Required

public readonly backupRetentionPeriod: number;

• Type: number

---

clusterIdentifier^Required

public readonly clusterIdentifier: string;

• Type: string

---

clusterIdentifierPrefix^Required

public readonly clusterIdentifierPrefix: string;

• Type: string

---

clusterMembers^Required

public readonly clusterMembers: string[];

• Type: string[]

---

dbClusterParameterGroupName^Required

public readonly dbClusterParameterGroupName: string;

• Type: string

---

dbSubnetGroupName^Required

public readonly dbSubnetGroupName: string;

• Type: string

---

deletionProtection^Required

public readonly deletionProtection: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

enabledCloudwatchLogsExports^Required

public readonly enabledCloudwatchLogsExports: string[];

• Type: string[]

---

engine^Required

public readonly engine: string;

• Type: string

---

engineVersion^Required

public readonly engineVersion: string;

• Type: string

---

finalSnapshotIdentifier^Required

public readonly finalSnapshotIdentifier: string;

• Type: string

---

globalClusterIdentifier^Required

public readonly globalClusterIdentifier: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

kmsKeyId^Required

public readonly kmsKeyId: string;

• Type: string

---

masterPassword^Required

public readonly masterPassword: string;

• Type: string

---

masterUsername^Required

public readonly masterUsername: string;

• Type: string

---

port^Required

public readonly port: number;

• Type: number

---

preferredBackupWindow^Required

public readonly preferredBackupWindow: string;

• Type: string

---

preferredMaintenanceWindow^Required

public readonly preferredMaintenanceWindow: string;

• Type: string

---

skipFinalSnapshot^Required

public readonly skipFinalSnapshot: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

snapshotIdentifier^Required

public readonly snapshotIdentifier: string;

• Type: string

---

storageEncrypted^Required

public readonly storageEncrypted: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

tags^Required

public readonly tags: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

tagsAll^Required

public readonly tagsAll: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

vpcSecurityGroupIds^Required

public readonly vpcSecurityGroupIds: string[];

• Type: string[]

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

DocdbClusterConfig

Initializer

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

const docdbClusterConfig: docdbCluster.DocdbClusterConfig = { ... }

Properties

Name	Type	Description
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	cdktf.ITerraformDependable[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
applyImmediately	boolean | cdktf.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#apply_immediately DocdbCluster#apply_immediately}.
availabilityZones	string[]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#availability_zones DocdbCluster#availability_zones}.
backupRetentionPeriod	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#backup_retention_period DocdbCluster#backup_retention_period}.
clusterIdentifier	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#cluster_identifier DocdbCluster#cluster_identifier}.
clusterIdentifierPrefix	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#cluster_identifier_prefix DocdbCluster#cluster_identifier_prefix}.
clusterMembers	string[]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#cluster_members DocdbCluster#cluster_members}.
dbClusterParameterGroupName	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#db_cluster_parameter_group_name DocdbCluster#db_cluster_parameter_group_name}.
dbSubnetGroupName	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#db_subnet_group_name DocdbCluster#db_subnet_group_name}.
deletionProtection	boolean | cdktf.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#deletion_protection DocdbCluster#deletion_protection}.
enabledCloudwatchLogsExports	string[]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#enabled_cloudwatch_logs_exports DocdbCluster#enabled_cloudwatch_logs_exports}.
engine	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#engine DocdbCluster#engine}.
engineVersion	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#engine_version DocdbCluster#engine_version}.
finalSnapshotIdentifier	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#final_snapshot_identifier DocdbCluster#final_snapshot_identifier}.
globalClusterIdentifier	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#global_cluster_identifier DocdbCluster#global_cluster_identifier}.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#id DocdbCluster#id}.
kmsKeyId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#kms_key_id DocdbCluster#kms_key_id}.
masterPassword	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#master_password DocdbCluster#master_password}.
masterUsername	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#master_username DocdbCluster#master_username}.
port	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#port DocdbCluster#port}.
preferredBackupWindow	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#preferred_backup_window DocdbCluster#preferred_backup_window}.
preferredMaintenanceWindow	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#preferred_maintenance_window DocdbCluster#preferred_maintenance_window}.
skipFinalSnapshot	boolean | cdktf.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#skip_final_snapshot DocdbCluster#skip_final_snapshot}.
snapshotIdentifier	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#snapshot_identifier DocdbCluster#snapshot_identifier}.
storageEncrypted	boolean | cdktf.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#storage_encrypted DocdbCluster#storage_encrypted}.
tags	{[ key: string ]: string}	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#tags DocdbCluster#tags}.
tagsAll	{[ key: string ]: string}	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#tags_all DocdbCluster#tags_all}.
timeouts	DocdbClusterTimeouts	timeouts block.
vpcSecurityGroupIds	string[]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#vpc_security_group_ids DocdbCluster#vpc_security_group_ids}.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktf.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

applyImmediately^Optional

public readonly applyImmediately: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#apply_immediately DocdbCluster#apply_immediately}.

---

availabilityZones^Optional

public readonly availabilityZones: string[];

• Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#availability_zones DocdbCluster#availability_zones}.

---

backupRetentionPeriod^Optional

public readonly backupRetentionPeriod: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#backup_retention_period DocdbCluster#backup_retention_period}.

---

clusterIdentifier^Optional

public readonly clusterIdentifier: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#cluster_identifier DocdbCluster#cluster_identifier}.

---

clusterIdentifierPrefix^Optional

public readonly clusterIdentifierPrefix: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#cluster_identifier_prefix DocdbCluster#cluster_identifier_prefix}.

---

clusterMembers^Optional

public readonly clusterMembers: string[];

• Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#cluster_members DocdbCluster#cluster_members}.

---

dbClusterParameterGroupName^Optional

public readonly dbClusterParameterGroupName: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#db_cluster_parameter_group_name DocdbCluster#db_cluster_parameter_group_name}.

---

dbSubnetGroupName^Optional

public readonly dbSubnetGroupName: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#db_subnet_group_name DocdbCluster#db_subnet_group_name}.

---

deletionProtection^Optional

public readonly deletionProtection: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#deletion_protection DocdbCluster#deletion_protection}.

---

enabledCloudwatchLogsExports^Optional

public readonly enabledCloudwatchLogsExports: string[];

• Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#enabled_cloudwatch_logs_exports DocdbCluster#enabled_cloudwatch_logs_exports}.

---

engine^Optional

public readonly engine: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#engine DocdbCluster#engine}.

---

engineVersion^Optional

public readonly engineVersion: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#engine_version DocdbCluster#engine_version}.

---

finalSnapshotIdentifier^Optional

public readonly finalSnapshotIdentifier: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#final_snapshot_identifier DocdbCluster#final_snapshot_identifier}.

---

globalClusterIdentifier^Optional

public readonly globalClusterIdentifier: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#global_cluster_identifier DocdbCluster#global_cluster_identifier}.

---

id^Optional

public readonly id: string;

• Type: string

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

---

kmsKeyId^Optional

public readonly kmsKeyId: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#kms_key_id DocdbCluster#kms_key_id}.

---

masterPassword^Optional

public readonly masterPassword: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#master_password DocdbCluster#master_password}.

---

masterUsername^Optional

public readonly masterUsername: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#master_username DocdbCluster#master_username}.

---

port^Optional

public readonly port: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#port DocdbCluster#port}.

---

preferredBackupWindow^Optional

public readonly preferredBackupWindow: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#preferred_backup_window DocdbCluster#preferred_backup_window}.

---

preferredMaintenanceWindow^Optional

public readonly preferredMaintenanceWindow: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#preferred_maintenance_window DocdbCluster#preferred_maintenance_window}.

---

skipFinalSnapshot^Optional

public readonly skipFinalSnapshot: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#skip_final_snapshot DocdbCluster#skip_final_snapshot}.

---

snapshotIdentifier^Optional

public readonly snapshotIdentifier: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#snapshot_identifier DocdbCluster#snapshot_identifier}.

---

storageEncrypted^Optional

public readonly storageEncrypted: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#storage_encrypted DocdbCluster#storage_encrypted}.

---

tags^Optional

public readonly tags: {[ key: string ]: string};

• Type: {[ key: string ]: string}

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

---

tagsAll^Optional

public readonly tagsAll: {[ key: string ]: string};

• Type: {[ key: string ]: string}

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

---

timeouts^Optional

public readonly timeouts: DocdbClusterTimeouts;

• Type: DocdbClusterTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#timeouts DocdbCluster#timeouts}

---

vpcSecurityGroupIds^Optional

public readonly vpcSecurityGroupIds: string[];

• Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#vpc_security_group_ids DocdbCluster#vpc_security_group_ids}.

---

DocdbClusterTimeouts

Initializer

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

const docdbClusterTimeouts: docdbCluster.DocdbClusterTimeouts = { ... }

Properties

Name	Type	Description
create	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#create DocdbCluster#create}.
delete	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#delete DocdbCluster#delete}.
update	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#update DocdbCluster#update}.

---

create^Optional

public readonly create: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#create DocdbCluster#create}.

---

delete^Optional

public readonly delete: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#delete DocdbCluster#delete}.

---

update^Optional

public readonly update: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster#update DocdbCluster#update}.

---

Classes

DocdbClusterTimeoutsOutputReference

Initializers

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

new docdbCluster.DocdbClusterTimeoutsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

Methods

Name	Description
computeFqn	No description.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
interpolationForAttribute	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
resetCreate	No description.
resetDelete	No description.
resetUpdate	No description.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetCreate

public resetCreate(): void

resetDelete

public resetDelete(): void

resetUpdate

public resetUpdate(): void

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
createInput	string	No description.
deleteInput	string	No description.
updateInput	string	No description.
create	string	No description.
delete	string	No description.
update	string	No description.
internalValue	cdktf.IResolvable | DocdbClusterTimeouts	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

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

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

---

fqn^Required

public readonly fqn: string;

• Type: string

---

createInput^Optional

public readonly createInput: string;

• Type: string

---

deleteInput^Optional

public readonly deleteInput: string;

• Type: string

---

updateInput^Optional

public readonly updateInput: string;

• Type: string

---

create^Required

public readonly create: string;

• Type: string

---

delete^Required

public readonly delete: string;

• Type: string

---

update^Required

public readonly update: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: IResolvable | DocdbClusterTimeouts;

• Type: cdktf.IResolvable | DocdbClusterTimeouts

---