`docdbClusterInstance` Submodule

Constructs

DocdbClusterInstance

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

Initializers

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

new docdbClusterInstance.DocdbClusterInstance(scope: Construct, id: string, config: DocdbClusterInstanceConfig)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`string`	The scoped construct ID.
`config`	`DocdbClusterInstanceConfig`	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`^Required

Type: DocdbClusterInstanceConfig

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`addOverride`	No description.
`overrideLogicalId`	Overrides the auto-generated logical ID with a specific ID.
`resetOverrideLogicalId`	Resets a previously passed logical Id to use the auto-generated logical id again.
`toHclTerraform`	No description.
`toMetadata`	No description.
`toTerraform`	Adds this resource to the terraform JSON output.
`addMoveTarget`	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
`getAnyMapAttribute`	No description.
`getBooleanAttribute`	No description.
`getBooleanMapAttribute`	No description.
`getListAttribute`	No description.
`getNumberAttribute`	No description.
`getNumberListAttribute`	No description.
`getNumberMapAttribute`	No description.
`getStringAttribute`	No description.
`getStringMapAttribute`	No description.
`hasResourceMove`	No description.
`importFrom`	No description.
`interpolationForAttribute`	No description.
`moveFromId`	Move the resource corresponding to "id" to this resource.
`moveTo`	Moves this resource to the target resource given by moveTarget.
`moveToId`	Moves this resource to the resource corresponding to "id".
`putTimeouts`	No description.
`resetApplyImmediately`	No description.
`resetAutoMinorVersionUpgrade`	No description.
`resetAvailabilityZone`	No description.
`resetCaCertIdentifier`	No description.
`resetEngine`	No description.
`resetId`	No description.
`resetIdentifier`	No description.
`resetIdentifierPrefix`	No description.
`resetPreferredMaintenanceWindow`	No description.
`resetPromotionTier`	No description.
`resetTags`	No description.
`resetTagsAll`	No description.
`resetTimeouts`	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.

`toHclTerraform`

public toHclTerraform(): any

`toMetadata`

public toMetadata(): any

`toTerraform`

public toTerraform(): any

Adds this resource to the terraform JSON output.

`addMoveTarget`

public addMoveTarget(moveTarget: string): void

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

`moveTarget`^Required

Type: string

The string move target that will correspond to this resource.

`getAnyMapAttribute`

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

`hasResourceMove`

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

`importFrom`

public importFrom(id: string, provider?: TerraformProvider): void

`id`^Required

Type: string

`provider`^Optional

Type: cdktf.TerraformProvider

`interpolationForAttribute`

public interpolationForAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`moveFromId`

public moveFromId(id: string): void

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

Note that the resource being moved from must be marked as moved using it's instance function.

`id`^Required

Type: string

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

`moveTo`

public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

`moveTarget`^Required

Type: string

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

`index`^Optional

Type: string | number

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

`moveToId`

public moveToId(id: string): void

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

`id`^Required

Type: string

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

`putTimeouts`

public putTimeouts(value: DocdbClusterInstanceTimeouts): void

`value`^Required

Type: DocdbClusterInstanceTimeouts

`resetApplyImmediately`

public resetApplyImmediately(): void

`resetAutoMinorVersionUpgrade`

public resetAutoMinorVersionUpgrade(): void

`resetAvailabilityZone`

public resetAvailabilityZone(): void

`resetCaCertIdentifier`

public resetCaCertIdentifier(): void

`resetEngine`

public resetEngine(): void

`resetId`

public resetId(): void

`resetIdentifier`

public resetIdentifier(): void

`resetIdentifierPrefix`

public resetIdentifierPrefix(): void

`resetPreferredMaintenanceWindow`

public resetPreferredMaintenanceWindow(): void

`resetPromotionTier`

public resetPromotionTier(): void

`resetTags`

public resetTags(): void

`resetTagsAll`

public resetTagsAll(): void

`resetTimeouts`

public resetTimeouts(): void

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isTerraformElement`	No description.
`isTerraformResource`	No description.
`generateConfigForImport`	Generates CDKTF code for importing a DocdbClusterInstance resource upon running "cdktf plan ".

`isConstruct`

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

docdbClusterInstance.DocdbClusterInstance.isConstruct(x: any)

Checks if x is a construct.

`x`^Required

Type: any

Any object.

`isTerraformElement`

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

docdbClusterInstance.DocdbClusterInstance.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformResource`

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

docdbClusterInstance.DocdbClusterInstance.isTerraformResource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

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

docdbClusterInstance.DocdbClusterInstance.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`importToId`^Required

Type: string

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

`importFromId`^Required

Type: string

The id of the existing DocdbClusterInstance that should be imported.

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

`provider`^Optional

Type: cdktf.TerraformProvider

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

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.
`dbiResourceId`	`string`	No description.
`dbSubnetGroupName`	`string`	No description.
`endpoint`	`string`	No description.
`engineVersion`	`string`	No description.
`kmsKeyId`	`string`	No description.
`port`	`number`	No description.
`preferredBackupWindow`	`string`	No description.
`publiclyAccessible`	`cdktf.IResolvable`	No description.
`storageEncrypted`	`cdktf.IResolvable`	No description.
`timeouts`	`DocdbClusterInstanceTimeoutsOutputReference`	No description.
`writer`	`cdktf.IResolvable`	No description.
`applyImmediatelyInput`	`boolean \| cdktf.IResolvable`	No description.
`autoMinorVersionUpgradeInput`	`boolean \| cdktf.IResolvable`	No description.
`availabilityZoneInput`	`string`	No description.
`caCertIdentifierInput`	`string`	No description.
`clusterIdentifierInput`	`string`	No description.
`engineInput`	`string`	No description.
`identifierInput`	`string`	No description.
`identifierPrefixInput`	`string`	No description.
`idInput`	`string`	No description.
`instanceClassInput`	`string`	No description.
`preferredMaintenanceWindowInput`	`string`	No description.
`promotionTierInput`	`number`	No description.
`tagsAllInput`	`{[ key: string ]: string}`	No description.
`tagsInput`	`{[ key: string ]: string}`	No description.
`timeoutsInput`	`cdktf.IResolvable \| DocdbClusterInstanceTimeouts`	No description.
`applyImmediately`	`boolean \| cdktf.IResolvable`	No description.
`autoMinorVersionUpgrade`	`boolean \| cdktf.IResolvable`	No description.
`availabilityZone`	`string`	No description.
`caCertIdentifier`	`string`	No description.
`clusterIdentifier`	`string`	No description.
`engine`	`string`	No description.
`id`	`string`	No description.
`identifier`	`string`	No description.
`identifierPrefix`	`string`	No description.
`instanceClass`	`string`	No description.
`preferredMaintenanceWindow`	`string`	No description.
`promotionTier`	`number`	No description.
`tags`	`{[ key: string ]: string}`	No description.
`tagsAll`	`{[ key: string ]: 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

`dbiResourceId`^Required

public readonly dbiResourceId: string;

Type: string

`dbSubnetGroupName`^Required

public readonly dbSubnetGroupName: string;

Type: string

`endpoint`^Required

public readonly endpoint: string;

Type: string

`engineVersion`^Required

public readonly engineVersion: string;

Type: string

`kmsKeyId`^Required

public readonly kmsKeyId: string;

Type: string

`port`^Required

public readonly port: number;

Type: number

`preferredBackupWindow`^Required

public readonly preferredBackupWindow: string;

Type: string

`publiclyAccessible`^Required

public readonly publiclyAccessible: IResolvable;

Type: cdktf.IResolvable

`storageEncrypted`^Required

public readonly storageEncrypted: IResolvable;

Type: cdktf.IResolvable

`timeouts`^Required

public readonly timeouts: DocdbClusterInstanceTimeoutsOutputReference;

Type: DocdbClusterInstanceTimeoutsOutputReference

`writer`^Required

public readonly writer: IResolvable;

Type: cdktf.IResolvable

`applyImmediatelyInput`^Optional

public readonly applyImmediatelyInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`autoMinorVersionUpgradeInput`^Optional

public readonly autoMinorVersionUpgradeInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`availabilityZoneInput`^Optional

public readonly availabilityZoneInput: string;

Type: string

`caCertIdentifierInput`^Optional

public readonly caCertIdentifierInput: string;

Type: string

`clusterIdentifierInput`^Optional

public readonly clusterIdentifierInput: string;

Type: string

`engineInput`^Optional

public readonly engineInput: string;

Type: string

`identifierInput`^Optional

public readonly identifierInput: string;

Type: string

`identifierPrefixInput`^Optional

public readonly identifierPrefixInput: string;

Type: string

`idInput`^Optional

public readonly idInput: string;

Type: string

`instanceClassInput`^Optional

public readonly instanceClassInput: string;

Type: string

`preferredMaintenanceWindowInput`^Optional

public readonly preferredMaintenanceWindowInput: string;

Type: string

`promotionTierInput`^Optional

public readonly promotionTierInput: number;

Type: number

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

Type: cdktf.IResolvable | DocdbClusterInstanceTimeouts

`applyImmediately`^Required

public readonly applyImmediately: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`autoMinorVersionUpgrade`^Required

public readonly autoMinorVersionUpgrade: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`availabilityZone`^Required

public readonly availabilityZone: string;

Type: string

`caCertIdentifier`^Required

public readonly caCertIdentifier: string;

Type: string

`clusterIdentifier`^Required

public readonly clusterIdentifier: string;

Type: string

`engine`^Required

public readonly engine: string;

Type: string

`id`^Required

public readonly id: string;

Type: string

`identifier`^Required

public readonly identifier: string;

Type: string

`identifierPrefix`^Required

public readonly identifierPrefix: string;

Type: string

`instanceClass`^Required

public readonly instanceClass: string;

Type: string

`preferredMaintenanceWindow`^Required

public readonly preferredMaintenanceWindow: string;

Type: string

`promotionTier`^Required

public readonly promotionTier: number;

Type: number

`tags`^Required

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

Type: {[ key: string ]: string}

`tagsAll`^Required

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

Type: {[ key: string ]: string}

Constants

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

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

DocdbClusterInstanceConfig

Initializer

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

const docdbClusterInstanceConfig: docdbClusterInstance.DocdbClusterInstanceConfig = { ... }

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.
`clusterIdentifier`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster_instance#cluster_identifier DocdbClusterInstance#cluster_identifier}.
`instanceClass`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster_instance#instance_class DocdbClusterInstance#instance_class}.
`applyImmediately`	`boolean \| cdktf.IResolvable`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster_instance#apply_immediately DocdbClusterInstance#apply_immediately}.
`autoMinorVersionUpgrade`	`boolean \| cdktf.IResolvable`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster_instance#auto_minor_version_upgrade DocdbClusterInstance#auto_minor_version_upgrade}.
`availabilityZone`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster_instance#availability_zone DocdbClusterInstance#availability_zone}.
`caCertIdentifier`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster_instance#ca_cert_identifier DocdbClusterInstance#ca_cert_identifier}.
`engine`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster_instance#engine DocdbClusterInstance#engine}.
`id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster_instance#id DocdbClusterInstance#id}.
`identifier`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster_instance#identifier DocdbClusterInstance#identifier}.
`identifierPrefix`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster_instance#identifier_prefix DocdbClusterInstance#identifier_prefix}.
`preferredMaintenanceWindow`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster_instance#preferred_maintenance_window DocdbClusterInstance#preferred_maintenance_window}.
`promotionTier`	`number`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster_instance#promotion_tier DocdbClusterInstance#promotion_tier}.
`tags`	`{[ key: string ]: string}`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster_instance#tags DocdbClusterInstance#tags}.
`tagsAll`	`{[ key: string ]: string}`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster_instance#tags_all DocdbClusterInstance#tags_all}.
`timeouts`	`DocdbClusterInstanceTimeouts`	timeouts block.

`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[]

`clusterIdentifier`^Required

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_instance#cluster_identifier DocdbClusterInstance#cluster_identifier}.

`instanceClass`^Required

public readonly instanceClass: string;

Type: string

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

`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_instance#apply_immediately DocdbClusterInstance#apply_immediately}.

`autoMinorVersionUpgrade`^Optional

public readonly autoMinorVersionUpgrade: 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_instance#auto_minor_version_upgrade DocdbClusterInstance#auto_minor_version_upgrade}.

`availabilityZone`^Optional

public readonly availabilityZone: string;

Type: string

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

`caCertIdentifier`^Optional

public readonly caCertIdentifier: string;

Type: string

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

`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_instance#engine DocdbClusterInstance#engine}.

`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_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.

`identifier`^Optional

public readonly identifier: string;

Type: string

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

`identifierPrefix`^Optional

public readonly identifierPrefix: string;

Type: string

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

`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_instance#preferred_maintenance_window DocdbClusterInstance#preferred_maintenance_window}.

`promotionTier`^Optional

public readonly promotionTier: number;

Type: number

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

`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_instance#tags DocdbClusterInstance#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_instance#tags_all DocdbClusterInstance#tags_all}.

`timeouts`^Optional

public readonly timeouts: DocdbClusterInstanceTimeouts;

Type: DocdbClusterInstanceTimeouts

timeouts block.

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

DocdbClusterInstanceTimeouts

Initializer

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

const docdbClusterInstanceTimeouts: docdbClusterInstance.DocdbClusterInstanceTimeouts = { ... }

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_instance#create DocdbClusterInstance#create}.
`delete`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster_instance#delete DocdbClusterInstance#delete}.
`update`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/docdb_cluster_instance#update DocdbClusterInstance#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_instance#create DocdbClusterInstance#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_instance#delete DocdbClusterInstance#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_instance#update DocdbClusterInstance#update}.

Classes

DocdbClusterInstanceTimeoutsOutputReference

Initializers

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

new docdbClusterInstance.DocdbClusterInstanceTimeoutsOutputReference(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 \| DocdbClusterInstanceTimeouts`	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 | DocdbClusterInstanceTimeouts;

Type: cdktf.IResolvable | DocdbClusterInstanceTimeouts

Files

docdbClusterInstance.md

Latest commit

History

docdbClusterInstance.md

File metadata and controls

docdbClusterInstance Submodule

Constructs