docdbCluster.csharp.md

docdbCluster Submodule

Constructs

DocdbCluster

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

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new DocdbCluster(Construct Scope, string Id, DocdbClusterConfig Config = null);

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.
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.
ResetAllowMajorVersionUpgrade	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.
ResetStorageType	No description.
ResetTags	No description.
ResetTagsAll	No description.
ResetTimeouts	No description.
ResetVpcSecurityGroupIds	No description.

---

ToString

private string ToString()

Returns a string representation of this construct.

AddOverride

private void AddOverride(string Path, object Value)

Path^Required

• Type: string

---

Value^Required

• Type: object

---

OverrideLogicalId

private void OverrideLogicalId(string NewLogicalId)

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

private void ResetOverrideLogicalId()

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

ToHclTerraform

private object ToHclTerraform()

ToMetadata

private object ToMetadata()

ToTerraform

private object ToTerraform()

Adds this resource to the terraform JSON output.

AddMoveTarget

private void AddMoveTarget(string MoveTarget)

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

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanAttribute

private IResolvable GetBooleanAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanMapAttribute

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetListAttribute

private string[] GetListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberAttribute

private double GetNumberAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberListAttribute

private double[] GetNumberListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberMapAttribute

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringAttribute

private string GetStringAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringMapAttribute

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

HasResourceMove

private object HasResourceMove()

ImportFrom

private void ImportFrom(string Id, TerraformProvider Provider = null)

Id^Required

• Type: string

---

Provider^Optional

• Type: HashiCorp.Cdktf.TerraformProvider

---

InterpolationForAttribute

private IResolvable InterpolationForAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

MoveFromId

private void MoveFromId(string Id)

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

private void MoveTo(string MoveTarget, object Index = null)

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

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

---

MoveToId

private void MoveToId(string Id)

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

private void PutTimeouts(DocdbClusterTimeouts Value)

Value^Required

• Type: DocdbClusterTimeouts

---

ResetAllowMajorVersionUpgrade

private void ResetAllowMajorVersionUpgrade()

ResetApplyImmediately

private void ResetApplyImmediately()

ResetAvailabilityZones

private void ResetAvailabilityZones()

ResetBackupRetentionPeriod

private void ResetBackupRetentionPeriod()

ResetClusterIdentifier

private void ResetClusterIdentifier()

ResetClusterIdentifierPrefix

private void ResetClusterIdentifierPrefix()

ResetClusterMembers

private void ResetClusterMembers()

ResetDbClusterParameterGroupName

private void ResetDbClusterParameterGroupName()

ResetDbSubnetGroupName

private void ResetDbSubnetGroupName()

ResetDeletionProtection

private void ResetDeletionProtection()

ResetEnabledCloudwatchLogsExports

private void ResetEnabledCloudwatchLogsExports()

ResetEngine

private void ResetEngine()

ResetEngineVersion

private void ResetEngineVersion()

ResetFinalSnapshotIdentifier

private void ResetFinalSnapshotIdentifier()

ResetGlobalClusterIdentifier

private void ResetGlobalClusterIdentifier()

ResetId

private void ResetId()

ResetKmsKeyId

private void ResetKmsKeyId()

ResetMasterPassword

private void ResetMasterPassword()

ResetMasterUsername

private void ResetMasterUsername()

ResetPort

private void ResetPort()

ResetPreferredBackupWindow

private void ResetPreferredBackupWindow()

ResetPreferredMaintenanceWindow

private void ResetPreferredMaintenanceWindow()

ResetSkipFinalSnapshot

private void ResetSkipFinalSnapshot()

ResetSnapshotIdentifier

private void ResetSnapshotIdentifier()

ResetStorageEncrypted

private void ResetStorageEncrypted()

ResetStorageType

private void ResetStorageType()

ResetTags

private void ResetTags()

ResetTagsAll

private void ResetTagsAll()

ResetTimeouts

private void ResetTimeouts()

ResetVpcSecurityGroupIds

private void ResetVpcSecurityGroupIds()

Static Functions

Name	Description
IsConstruct	Checks if x is a construct.
IsTerraformElement	No description.
IsTerraformResource	No description.
GenerateConfigForImport	Generates CDKTF code for importing a DocdbCluster resource upon running "cdktf plan ".

---

IsConstruct

using HashiCorp.Cdktf.Providers.Aws;

DocdbCluster.IsConstruct(object X);

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

Any object.

---

IsTerraformElement

using HashiCorp.Cdktf.Providers.Aws;

DocdbCluster.IsTerraformElement(object X);

X^Required

• Type: object

---

IsTerraformResource

using HashiCorp.Cdktf.Providers.Aws;

DocdbCluster.IsTerraformResource(object X);

X^Required

• Type: object

---

GenerateConfigForImport

using HashiCorp.Cdktf.Providers.Aws;

DocdbCluster.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

Generates CDKTF code for importing a DocdbCluster 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 DocdbCluster to import.

---

ImportFromId^Required

• Type: string

The id of the existing DocdbCluster that should be imported.

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

---

Provider^Optional

• Type: HashiCorp.Cdktf.TerraformProvider

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

---

Properties

Name	Type	Description
Node	Constructs.Node	The tree node.
CdktfStack	HashiCorp.Cdktf.TerraformStack	No description.
Fqn	string	No description.
FriendlyUniqueId	string	No description.
TerraformMetaArguments	System.Collections.Generic.IDictionary<string, object>	No description.
TerraformResourceType	string	No description.
TerraformGeneratorMetadata	HashiCorp.Cdktf.TerraformProviderGeneratorMetadata	No description.
Connection	object	No description.
Count	object	No description.
DependsOn	string[]	No description.
ForEach	HashiCorp.Cdktf.ITerraformIterator	No description.
Lifecycle	HashiCorp.Cdktf.TerraformResourceLifecycle	No description.
Provider	HashiCorp.Cdktf.TerraformProvider	No description.
Provisioners	object[]	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.
AllowMajorVersionUpgradeInput	object	No description.
ApplyImmediatelyInput	object	No description.
AvailabilityZonesInput	string[]	No description.
BackupRetentionPeriodInput	double	No description.
ClusterIdentifierInput	string	No description.
ClusterIdentifierPrefixInput	string	No description.
ClusterMembersInput	string[]	No description.
DbClusterParameterGroupNameInput	string	No description.
DbSubnetGroupNameInput	string	No description.
DeletionProtectionInput	object	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	double	No description.
PreferredBackupWindowInput	string	No description.
PreferredMaintenanceWindowInput	string	No description.
SkipFinalSnapshotInput	object	No description.
SnapshotIdentifierInput	string	No description.
StorageEncryptedInput	object	No description.
StorageTypeInput	string	No description.
TagsAllInput	System.Collections.Generic.IDictionary<string, string>	No description.
TagsInput	System.Collections.Generic.IDictionary<string, string>	No description.
TimeoutsInput	object	No description.
VpcSecurityGroupIdsInput	string[]	No description.
AllowMajorVersionUpgrade	object	No description.
ApplyImmediately	object	No description.
AvailabilityZones	string[]	No description.
BackupRetentionPeriod	double	No description.
ClusterIdentifier	string	No description.
ClusterIdentifierPrefix	string	No description.
ClusterMembers	string[]	No description.
DbClusterParameterGroupName	string	No description.
DbSubnetGroupName	string	No description.
DeletionProtection	object	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	double	No description.
PreferredBackupWindow	string	No description.
PreferredMaintenanceWindow	string	No description.
SkipFinalSnapshot	object	No description.
SnapshotIdentifier	string	No description.
StorageEncrypted	object	No description.
StorageType	string	No description.
Tags	System.Collections.Generic.IDictionary<string, string>	No description.
TagsAll	System.Collections.Generic.IDictionary<string, string>	No description.
VpcSecurityGroupIds	string[]	No description.

---

Node^Required

public Node Node { get; }

• Type: Constructs.Node

The tree node.

---

CdktfStack^Required

public TerraformStack CdktfStack { get; }

• Type: HashiCorp.Cdktf.TerraformStack

---

Fqn^Required

public string Fqn { get; }

• Type: string

---

FriendlyUniqueId^Required

public string FriendlyUniqueId { get; }

• Type: string

---

TerraformMetaArguments^Required

public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }

• Type: System.Collections.Generic.IDictionary<string, object>

---

TerraformResourceType^Required

public string TerraformResourceType { get; }

• Type: string

---

TerraformGeneratorMetadata^Optional

public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }

• Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

---

Connection^Optional

public object Connection { get; }

• Type: object

---

Count^Optional

public object Count { get; }

• Type: object

---

DependsOn^Optional

public string[] DependsOn { get; }

• Type: string[]

---

ForEach^Optional

public ITerraformIterator ForEach { get; }

• Type: HashiCorp.Cdktf.ITerraformIterator

---

Lifecycle^Optional

public TerraformResourceLifecycle Lifecycle { get; }

• Type: HashiCorp.Cdktf.TerraformResourceLifecycle

---

Provider^Optional

public TerraformProvider Provider { get; }

• Type: HashiCorp.Cdktf.TerraformProvider

---

Provisioners^Optional

public object[] Provisioners { get; }

• Type: object[]

---

Arn^Required

public string Arn { get; }

• Type: string

---

ClusterResourceId^Required

public string ClusterResourceId { get; }

• Type: string

---

Endpoint^Required

public string Endpoint { get; }

• Type: string

---

HostedZoneId^Required

public string HostedZoneId { get; }

• Type: string

---

ReaderEndpoint^Required

public string ReaderEndpoint { get; }

• Type: string

---

Timeouts^Required

public DocdbClusterTimeoutsOutputReference Timeouts { get; }

• Type: DocdbClusterTimeoutsOutputReference

---

AllowMajorVersionUpgradeInput^Optional

public object AllowMajorVersionUpgradeInput { get; }

• Type: object

---

ApplyImmediatelyInput^Optional

public object ApplyImmediatelyInput { get; }

• Type: object

---

AvailabilityZonesInput^Optional

public string[] AvailabilityZonesInput { get; }

• Type: string[]

---

BackupRetentionPeriodInput^Optional

public double BackupRetentionPeriodInput { get; }

• Type: double

---

ClusterIdentifierInput^Optional

public string ClusterIdentifierInput { get; }

• Type: string

---

ClusterIdentifierPrefixInput^Optional

public string ClusterIdentifierPrefixInput { get; }

• Type: string

---

ClusterMembersInput^Optional

public string[] ClusterMembersInput { get; }

• Type: string[]

---

DbClusterParameterGroupNameInput^Optional

public string DbClusterParameterGroupNameInput { get; }

• Type: string

---

DbSubnetGroupNameInput^Optional

public string DbSubnetGroupNameInput { get; }

• Type: string

---

DeletionProtectionInput^Optional

public object DeletionProtectionInput { get; }

• Type: object

---

EnabledCloudwatchLogsExportsInput^Optional

public string[] EnabledCloudwatchLogsExportsInput { get; }

• Type: string[]

---

EngineInput^Optional

public string EngineInput { get; }

• Type: string

---

EngineVersionInput^Optional

public string EngineVersionInput { get; }

• Type: string

---

FinalSnapshotIdentifierInput^Optional

public string FinalSnapshotIdentifierInput { get; }

• Type: string

---

GlobalClusterIdentifierInput^Optional

public string GlobalClusterIdentifierInput { get; }

• Type: string

---

IdInput^Optional

public string IdInput { get; }

• Type: string

---

KmsKeyIdInput^Optional

public string KmsKeyIdInput { get; }

• Type: string

---

MasterPasswordInput^Optional

public string MasterPasswordInput { get; }

• Type: string

---

MasterUsernameInput^Optional

public string MasterUsernameInput { get; }

• Type: string

---

PortInput^Optional

public double PortInput { get; }

• Type: double

---

PreferredBackupWindowInput^Optional

public string PreferredBackupWindowInput { get; }

• Type: string

---

PreferredMaintenanceWindowInput^Optional

public string PreferredMaintenanceWindowInput { get; }

• Type: string

---

SkipFinalSnapshotInput^Optional

public object SkipFinalSnapshotInput { get; }

• Type: object

---

SnapshotIdentifierInput^Optional

public string SnapshotIdentifierInput { get; }

• Type: string

---

StorageEncryptedInput^Optional

public object StorageEncryptedInput { get; }

• Type: object

---

StorageTypeInput^Optional

public string StorageTypeInput { get; }

• Type: string

---

TagsAllInput^Optional

public System.Collections.Generic.IDictionary<string, string> TagsAllInput { get; }

• Type: System.Collections.Generic.IDictionary<string, string>

---

TagsInput^Optional

public System.Collections.Generic.IDictionary<string, string> TagsInput { get; }

• Type: System.Collections.Generic.IDictionary<string, string>

---

TimeoutsInput^Optional

public object TimeoutsInput { get; }

• Type: object

---

VpcSecurityGroupIdsInput^Optional

public string[] VpcSecurityGroupIdsInput { get; }

• Type: string[]

---

AllowMajorVersionUpgrade^Required

public object AllowMajorVersionUpgrade { get; }

• Type: object

---

ApplyImmediately^Required

public object ApplyImmediately { get; }

• Type: object

---

AvailabilityZones^Required

public string[] AvailabilityZones { get; }

• Type: string[]

---

BackupRetentionPeriod^Required

public double BackupRetentionPeriod { get; }

• Type: double

---

ClusterIdentifier^Required

public string ClusterIdentifier { get; }

• Type: string

---

ClusterIdentifierPrefix^Required

public string ClusterIdentifierPrefix { get; }

• Type: string

---

ClusterMembers^Required

public string[] ClusterMembers { get; }

• Type: string[]

---

DbClusterParameterGroupName^Required

public string DbClusterParameterGroupName { get; }

• Type: string

---

DbSubnetGroupName^Required

public string DbSubnetGroupName { get; }

• Type: string

---

DeletionProtection^Required

public object DeletionProtection { get; }

• Type: object

---

EnabledCloudwatchLogsExports^Required

public string[] EnabledCloudwatchLogsExports { get; }

• Type: string[]

---

Engine^Required

public string Engine { get; }

• Type: string

---

EngineVersion^Required

public string EngineVersion { get; }

• Type: string

---

FinalSnapshotIdentifier^Required

public string FinalSnapshotIdentifier { get; }

• Type: string

---

GlobalClusterIdentifier^Required

public string GlobalClusterIdentifier { get; }

• Type: string

---

Id^Required

public string Id { get; }

• Type: string

---

KmsKeyId^Required

public string KmsKeyId { get; }

• Type: string

---

MasterPassword^Required

public string MasterPassword { get; }

• Type: string

---

MasterUsername^Required

public string MasterUsername { get; }

• Type: string

---

Port^Required

public double Port { get; }

• Type: double

---

PreferredBackupWindow^Required

public string PreferredBackupWindow { get; }

• Type: string

---

PreferredMaintenanceWindow^Required

public string PreferredMaintenanceWindow { get; }

• Type: string

---

SkipFinalSnapshot^Required

public object SkipFinalSnapshot { get; }

• Type: object

---

SnapshotIdentifier^Required

public string SnapshotIdentifier { get; }

• Type: string

---

StorageEncrypted^Required

public object StorageEncrypted { get; }

• Type: object

---

StorageType^Required

public string StorageType { get; }

• Type: string

---

Tags^Required

public System.Collections.Generic.IDictionary<string, string> Tags { get; }

• Type: System.Collections.Generic.IDictionary<string, string>

---

TagsAll^Required

public System.Collections.Generic.IDictionary<string, string> TagsAll { get; }

• Type: System.Collections.Generic.IDictionary<string, string>

---

VpcSecurityGroupIds^Required

public string[] VpcSecurityGroupIds { get; }

• Type: string[]

---

Constants

Name	Type	Description
TfResourceType	string	No description.

---

TfResourceType^Required

public string TfResourceType { get; }

• Type: string

---

Structs

DocdbClusterConfig

Initializer

using HashiCorp.Cdktf.Providers.Aws;

new DocdbClusterConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    object AllowMajorVersionUpgrade = null,
    object ApplyImmediately = null,
    string[] AvailabilityZones = null,
    double BackupRetentionPeriod = null,
    string ClusterIdentifier = null,
    string ClusterIdentifierPrefix = null,
    string[] ClusterMembers = null,
    string DbClusterParameterGroupName = null,
    string DbSubnetGroupName = null,
    object DeletionProtection = null,
    string[] EnabledCloudwatchLogsExports = null,
    string Engine = null,
    string EngineVersion = null,
    string FinalSnapshotIdentifier = null,
    string GlobalClusterIdentifier = null,
    string Id = null,
    string KmsKeyId = null,
    string MasterPassword = null,
    string MasterUsername = null,
    double Port = null,
    string PreferredBackupWindow = null,
    string PreferredMaintenanceWindow = null,
    object SkipFinalSnapshot = null,
    string SnapshotIdentifier = null,
    object StorageEncrypted = null,
    string StorageType = null,
    System.Collections.Generic.IDictionary<string, string> Tags = null,
    System.Collections.Generic.IDictionary<string, string> TagsAll = null,
    DocdbClusterTimeouts Timeouts = null,
    string[] VpcSecurityGroupIds = null
};

Properties

Name	Type	Description
Connection	object	No description.
Count	object	No description.
DependsOn	HashiCorp.Cdktf.ITerraformDependable[]	No description.
ForEach	HashiCorp.Cdktf.ITerraformIterator	No description.
Lifecycle	HashiCorp.Cdktf.TerraformResourceLifecycle	No description.
Provider	HashiCorp.Cdktf.TerraformProvider	No description.
Provisioners	object[]	No description.
AllowMajorVersionUpgrade	object	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster#allow_major_version_upgrade DocdbCluster#allow_major_version_upgrade}.
ApplyImmediately	object	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster#apply_immediately DocdbCluster#apply_immediately}.
AvailabilityZones	string[]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster#availability_zones DocdbCluster#availability_zones}.
BackupRetentionPeriod	double	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/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/5.52.0/docs/resources/docdb_cluster#cluster_identifier DocdbCluster#cluster_identifier}.
ClusterIdentifierPrefix	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/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/5.52.0/docs/resources/docdb_cluster#cluster_members DocdbCluster#cluster_members}.
DbClusterParameterGroupName	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/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/5.52.0/docs/resources/docdb_cluster#db_subnet_group_name DocdbCluster#db_subnet_group_name}.
DeletionProtection	object	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster#deletion_protection DocdbCluster#deletion_protection}.
EnabledCloudwatchLogsExports	string[]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/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/5.52.0/docs/resources/docdb_cluster#engine DocdbCluster#engine}.
EngineVersion	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster#engine_version DocdbCluster#engine_version}.
FinalSnapshotIdentifier	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/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/5.52.0/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/5.52.0/docs/resources/docdb_cluster#id DocdbCluster#id}.
KmsKeyId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/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/5.52.0/docs/resources/docdb_cluster#master_password DocdbCluster#master_password}.
MasterUsername	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster#master_username DocdbCluster#master_username}.
Port	double	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster#port DocdbCluster#port}.
PreferredBackupWindow	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/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/5.52.0/docs/resources/docdb_cluster#preferred_maintenance_window DocdbCluster#preferred_maintenance_window}.
SkipFinalSnapshot	object	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/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/5.52.0/docs/resources/docdb_cluster#snapshot_identifier DocdbCluster#snapshot_identifier}.
StorageEncrypted	object	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster#storage_encrypted DocdbCluster#storage_encrypted}.
StorageType	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster#storage_type DocdbCluster#storage_type}.
Tags	System.Collections.Generic.IDictionary<string, string>	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/docdb_cluster#tags DocdbCluster#tags}.
TagsAll	System.Collections.Generic.IDictionary<string, string>	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/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/5.52.0/docs/resources/docdb_cluster#vpc_security_group_ids DocdbCluster#vpc_security_group_ids}.

---

Connection^Optional

public object Connection { get; set; }

• Type: object

---

Count^Optional

public object Count { get; set; }

• Type: object

---

DependsOn^Optional

public ITerraformDependable[] DependsOn { get; set; }

• Type: HashiCorp.Cdktf.ITerraformDependable[]

---

ForEach^Optional

public ITerraformIterator ForEach { get; set; }

• Type: HashiCorp.Cdktf.ITerraformIterator

---

Lifecycle^Optional

public TerraformResourceLifecycle Lifecycle { get; set; }

• Type: HashiCorp.Cdktf.TerraformResourceLifecycle

---

Provider^Optional

public TerraformProvider Provider { get; set; }

• Type: HashiCorp.Cdktf.TerraformProvider

---

Provisioners^Optional

public object[] Provisioners { get; set; }

• Type: object[]

---

AllowMajorVersionUpgrade^Optional

public object AllowMajorVersionUpgrade { get; set; }

• Type: object

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

---

ApplyImmediately^Optional

public object ApplyImmediately { get; set; }

• Type: object

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

---

AvailabilityZones^Optional

public string[] AvailabilityZones { get; set; }

• Type: string[]

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

---

BackupRetentionPeriod^Optional

public double BackupRetentionPeriod { get; set; }

• Type: double

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

---

ClusterIdentifier^Optional

public string ClusterIdentifier { get; set; }

• Type: string

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

---

ClusterIdentifierPrefix^Optional

public string ClusterIdentifierPrefix { get; set; }

• Type: string

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

---

ClusterMembers^Optional

public string[] ClusterMembers { get; set; }

• Type: string[]

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

---

DbClusterParameterGroupName^Optional

public string DbClusterParameterGroupName { get; set; }

• Type: string

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

---

DbSubnetGroupName^Optional

public string DbSubnetGroupName { get; set; }

• Type: string

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

---

DeletionProtection^Optional

public object DeletionProtection { get; set; }

• Type: object

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

---

EnabledCloudwatchLogsExports^Optional

public string[] EnabledCloudwatchLogsExports { get; set; }

• Type: string[]

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

---

Engine^Optional

public string Engine { get; set; }

• Type: string

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

---

EngineVersion^Optional

public string EngineVersion { get; set; }

• Type: string

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

---

FinalSnapshotIdentifier^Optional

public string FinalSnapshotIdentifier { get; set; }

• Type: string

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

---

GlobalClusterIdentifier^Optional

public string GlobalClusterIdentifier { get; set; }

• Type: string

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

---

Id^Optional

public string Id { get; set; }

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/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 string KmsKeyId { get; set; }

• Type: string

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

---

MasterPassword^Optional

public string MasterPassword { get; set; }

• Type: string

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

---

MasterUsername^Optional

public string MasterUsername { get; set; }

• Type: string

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

---

Port^Optional

public double Port { get; set; }

• Type: double

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

---

PreferredBackupWindow^Optional

public string PreferredBackupWindow { get; set; }

• Type: string

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

---

PreferredMaintenanceWindow^Optional

public string PreferredMaintenanceWindow { get; set; }

• Type: string

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

---

SkipFinalSnapshot^Optional

public object SkipFinalSnapshot { get; set; }

• Type: object

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

---

SnapshotIdentifier^Optional

public string SnapshotIdentifier { get; set; }

• Type: string

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

---

StorageEncrypted^Optional

public object StorageEncrypted { get; set; }

• Type: object

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

---

StorageType^Optional

public string StorageType { get; set; }

• Type: string

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

---

Tags^Optional

public System.Collections.Generic.IDictionary<string, string> Tags { get; set; }

• Type: System.Collections.Generic.IDictionary<string, string>

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

---

TagsAll^Optional

public System.Collections.Generic.IDictionary<string, string> TagsAll { get; set; }

• Type: System.Collections.Generic.IDictionary<string, string>

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

---

Timeouts^Optional

public DocdbClusterTimeouts Timeouts { get; set; }

• Type: DocdbClusterTimeouts

timeouts block.

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

---

VpcSecurityGroupIds^Optional

public string[] VpcSecurityGroupIds { get; set; }

• Type: string[]

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

---

DocdbClusterTimeouts

Initializer

using HashiCorp.Cdktf.Providers.Aws;

new DocdbClusterTimeouts {
    string Create = null,
    string Delete = null,
    string Update = null
};

Properties

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

---

Create^Optional

public string Create { get; set; }

• Type: string

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

---

Delete^Optional

public string Delete { get; set; }

• Type: string

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

---

Update^Optional

public string Update { get; set; }

• Type: string

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

---

Classes

DocdbClusterTimeoutsOutputReference

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new DocdbClusterTimeoutsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute);

Name	Type	Description
TerraformResource	HashiCorp.Cdktf.IInterpolatingParent	The parent resource.
TerraformAttribute	string	The attribute on the parent resource this class is referencing.

---

TerraformResource^Required

• Type: HashiCorp.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

private string ComputeFqn()

GetAnyMapAttribute

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanAttribute

private IResolvable GetBooleanAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanMapAttribute

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetListAttribute

private string[] GetListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberAttribute

private double GetNumberAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberListAttribute

private double[] GetNumberListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberMapAttribute

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringAttribute

private string GetStringAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringMapAttribute

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

InterpolationForAttribute

private IResolvable InterpolationForAttribute(string Property)

Property^Required

• Type: string

---

Resolve

private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

Context^Required

• Type: HashiCorp.Cdktf.IResolveContext

---

ToString

private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

ResetCreate

private void ResetCreate()

ResetDelete

private void ResetDelete()

ResetUpdate

private void ResetUpdate()

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	object	No description.

---

CreationStack^Required

public string[] CreationStack { get; }

• 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 string Fqn { get; }

• Type: string

---

CreateInput^Optional

public string CreateInput { get; }

• Type: string

---

DeleteInput^Optional

public string DeleteInput { get; }

• Type: string

---

UpdateInput^Optional

public string UpdateInput { get; }

• Type: string

---

Create^Required

public string Create { get; }

• Type: string

---

Delete^Required

public string Delete { get; }

• Type: string

---

Update^Required

public string Update { get; }

• Type: string

---

InternalValue^Optional

public object InternalValue { get; }

• Type: object

---