Skip to content

docdbClusterInstance.java.md

Latest commit

 

History

History
2433 lines (1530 loc) · 122 KB

docdbClusterInstance.java.md

File metadata and controls

2433 lines (1530 loc) · 122 KB

docdbClusterInstance Submodule

Constructs

DocdbClusterInstance

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

Initializers 

import io.cdktn.providers.aws.docdb_cluster_instance.DocdbClusterInstance;

DocdbClusterInstance.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection|WinrmProvisionerConnection)
//  .count(java.lang.Number|TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner>)
    .clusterIdentifier(java.lang.String)
    .instanceClass(java.lang.String)
//  .applyImmediately(java.lang.Boolean|IResolvable)
//  .autoMinorVersionUpgrade(java.lang.Boolean|IResolvable)
//  .availabilityZone(java.lang.String)
//  .caCertIdentifier(java.lang.String)
//  .certificateRotationRestart(java.lang.String)
//  .copyTagsToSnapshot(java.lang.Boolean|IResolvable)
//  .enablePerformanceInsights(java.lang.Boolean|IResolvable)
//  .engine(java.lang.String)
//  .id(java.lang.String)
//  .identifier(java.lang.String)
//  .identifierPrefix(java.lang.String)
//  .performanceInsightsKmsKeyId(java.lang.String)
//  .preferredMaintenanceWindow(java.lang.String)
//  .promotionTier(java.lang.Number)
//  .region(java.lang.String)
//  .tags(java.util.Map<java.lang.String, java.lang.String>)
//  .tagsAll(java.util.Map<java.lang.String, java.lang.String>)
//  .timeouts(DocdbClusterInstanceTimeouts)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
connection io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection No description.
count java.lang.Number|io.cdktn.cdktn.TerraformCount No description.
dependsOn java.util.List<io.cdktn.cdktn.ITerraformDependable> No description.
forEach io.cdktn.cdktn.ITerraformIterator No description.
lifecycle io.cdktn.cdktn.TerraformResourceLifecycle No description.
provider io.cdktn.cdktn.TerraformProvider No description.
provisioners java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner> No description.
clusterIdentifier java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#cluster_identifier DocdbClusterInstance#cluster_identifier}.
instanceClass java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#instance_class DocdbClusterInstance#instance_class}.
applyImmediately java.lang.Boolean|io.cdktn.cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#apply_immediately DocdbClusterInstance#apply_immediately}.
autoMinorVersionUpgrade java.lang.Boolean|io.cdktn.cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#auto_minor_version_upgrade DocdbClusterInstance#auto_minor_version_upgrade}.
availabilityZone java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#availability_zone DocdbClusterInstance#availability_zone}.
caCertIdentifier java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#ca_cert_identifier DocdbClusterInstance#ca_cert_identifier}.
certificateRotationRestart java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#certificate_rotation_restart DocdbClusterInstance#certificate_rotation_restart}.
copyTagsToSnapshot java.lang.Boolean|io.cdktn.cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#copy_tags_to_snapshot DocdbClusterInstance#copy_tags_to_snapshot}.
enablePerformanceInsights java.lang.Boolean|io.cdktn.cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#enable_performance_insights DocdbClusterInstance#enable_performance_insights}.
engine java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#engine DocdbClusterInstance#engine}.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#id DocdbClusterInstance#id}.
identifier java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#identifier DocdbClusterInstance#identifier}.
identifierPrefix java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#identifier_prefix DocdbClusterInstance#identifier_prefix}.
performanceInsightsKmsKeyId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#performance_insights_kms_key_id DocdbClusterInstance#performance_insights_kms_key_id}.
preferredMaintenanceWindow java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#preferred_maintenance_window DocdbClusterInstance#preferred_maintenance_window}.
promotionTier java.lang.Number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#promotion_tier DocdbClusterInstance#promotion_tier}.
region java.lang.String Region where this resource will be managed. Defaults to the Region set in the provider configuration.
tags java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#tags DocdbClusterInstance#tags}.
tagsAll java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#tags_all DocdbClusterInstance#tags_all}.
timeouts DocdbClusterInstanceTimeouts timeouts block.
scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection
countOptional
  • Type: java.lang.Number|io.cdktn.cdktn.TerraformCount
dependsOnOptional
  • Type: java.util.List<io.cdktn.cdktn.ITerraformDependable>
forEachOptional
  • Type: io.cdktn.cdktn.ITerraformIterator
lifecycleOptional
  • Type: io.cdktn.cdktn.TerraformResourceLifecycle
providerOptional
  • Type: io.cdktn.cdktn.TerraformProvider
provisionersOptional
  • Type: java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner>
clusterIdentifierRequired
  • Type: java.lang.String

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

instanceClassRequired
  • Type: java.lang.String

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

applyImmediatelyOptional
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

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

autoMinorVersionUpgradeOptional
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

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

availabilityZoneOptional
  • Type: java.lang.String

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

caCertIdentifierOptional
  • Type: java.lang.String

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

certificateRotationRestartOptional
  • Type: java.lang.String

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

copyTagsToSnapshotOptional
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

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

enablePerformanceInsightsOptional
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

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

engineOptional
  • Type: java.lang.String

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

idOptional
  • Type: java.lang.String

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

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

identifierOptional
  • Type: java.lang.String

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

identifierPrefixOptional
  • Type: java.lang.String

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

performanceInsightsKmsKeyIdOptional
  • Type: java.lang.String

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

preferredMaintenanceWindowOptional
  • Type: java.lang.String

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

promotionTierOptional
  • Type: java.lang.Number

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

regionOptional
  • Type: java.lang.String

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

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

tagsOptional
  • Type: java.util.Map<java.lang.String, java.lang.String>

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

tagsAllOptional
  • Type: java.util.Map<java.lang.String, java.lang.String>

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

timeoutsOptional

timeouts block.

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

Methods

Name Description
toString Returns a string representation of this construct.
with Applies one or more mixins to 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.
resetCertificateRotationRestart No description.
resetCopyTagsToSnapshot No description.
resetEnablePerformanceInsights No description.
resetEngine No description.
resetId No description.
resetIdentifier No description.
resetIdentifierPrefix No description.
resetPerformanceInsightsKmsKeyId No description.
resetPreferredMaintenanceWindow No description.
resetPromotionTier No description.
resetRegion No description.
resetTags No description.
resetTagsAll No description.
resetTimeouts No description.
toString 
public java.lang.String toString()

Returns a string representation of this construct.

with 
public IConstruct with(IMixin... mixins)

Applies one or more mixins to this construct.

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

mixinsRequired
  • Type: software.constructs.IMixin...

The mixins to apply.

addOverride 
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String
valueRequired
  • Type: java.lang.Object
overrideLogicalId 
public void overrideLogicalId(java.lang.String newLogicalId)

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

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public void resetOverrideLogicalId()

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

toHclTerraform 
public java.lang.Object toHclTerraform()
toMetadata 
public java.lang.Object toMetadata()
toTerraform 
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

addMoveTarget 
public void addMoveTarget(java.lang.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.

moveTargetRequired
  • Type: java.lang.String

The string move target that will correspond to this resource.

getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
hasResourceMove 
public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove()
importFrom 
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
idRequired
  • Type: java.lang.String
providerOptional
  • Type: io.cdktn.cdktn.TerraformProvider
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
moveFromId 
public void moveFromId(java.lang.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.

idRequired
  • Type: java.lang.String

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

moveTo 
public void moveTo(java.lang.String moveTarget)
public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index)

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: java.lang.String

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

indexOptional
  • Type: java.lang.String|java.lang.Number

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

moveToId 
public void moveToId(java.lang.String id)

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

idRequired
  • Type: java.lang.String

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

putTimeouts 
public void putTimeouts(DocdbClusterInstanceTimeouts value)
valueRequired
resetApplyImmediately 
public void resetApplyImmediately()
resetAutoMinorVersionUpgrade 
public void resetAutoMinorVersionUpgrade()
resetAvailabilityZone 
public void resetAvailabilityZone()
resetCaCertIdentifier 
public void resetCaCertIdentifier()
resetCertificateRotationRestart 
public void resetCertificateRotationRestart()
resetCopyTagsToSnapshot 
public void resetCopyTagsToSnapshot()
resetEnablePerformanceInsights 
public void resetEnablePerformanceInsights()
resetEngine 
public void resetEngine()
resetId 
public void resetId()
resetIdentifier 
public void resetIdentifier()
resetIdentifierPrefix 
public void resetIdentifierPrefix()
resetPerformanceInsightsKmsKeyId 
public void resetPerformanceInsightsKmsKeyId()
resetPreferredMaintenanceWindow 
public void resetPreferredMaintenanceWindow()
resetPromotionTier 
public void resetPromotionTier()
resetRegion 
public void resetRegion()
resetTags 
public void resetTags()
resetTagsAll 
public void resetTagsAll()
resetTimeouts 
public void resetTimeouts()

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTN code for importing a DocdbClusterInstance resource upon running "cdktn plan ".
isConstruct 
import io.cdktn.providers.aws.docdb_cluster_instance.DocdbClusterInstance;

DocdbClusterInstance.isConstruct(java.lang.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.

xRequired
  • Type: java.lang.Object

Any object.

isTerraformElement 
import io.cdktn.providers.aws.docdb_cluster_instance.DocdbClusterInstance;

DocdbClusterInstance.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformResource 
import io.cdktn.providers.aws.docdb_cluster_instance.DocdbClusterInstance;

DocdbClusterInstance.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import io.cdktn.providers.aws.docdb_cluster_instance.DocdbClusterInstance;

DocdbClusterInstance.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DocdbClusterInstance.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

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

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: java.lang.String

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

importFromIdRequired
  • Type: java.lang.String

The id of the existing DocdbClusterInstance that should be imported.

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

providerOptional
  • Type: io.cdktn.cdktn.TerraformProvider

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

Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack io.cdktn.cdktn.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
terraformMetaArguments java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata io.cdktn.cdktn.TerraformProviderGeneratorMetadata No description.
connection io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection No description.
count java.lang.Number|io.cdktn.cdktn.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach io.cdktn.cdktn.ITerraformIterator No description.
lifecycle io.cdktn.cdktn.TerraformResourceLifecycle No description.
provider io.cdktn.cdktn.TerraformProvider No description.
provisioners java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner> No description.
arn java.lang.String No description.
dbiResourceId java.lang.String No description.
dbSubnetGroupName java.lang.String No description.
endpoint java.lang.String No description.
engineVersion java.lang.String No description.
kmsKeyId java.lang.String No description.
port java.lang.Number No description.
preferredBackupWindow java.lang.String No description.
publiclyAccessible io.cdktn.cdktn.IResolvable No description.
storageEncrypted io.cdktn.cdktn.IResolvable No description.
timeouts DocdbClusterInstanceTimeoutsOutputReference No description.
writer io.cdktn.cdktn.IResolvable No description.
applyImmediatelyInput java.lang.Boolean|io.cdktn.cdktn.IResolvable No description.
autoMinorVersionUpgradeInput java.lang.Boolean|io.cdktn.cdktn.IResolvable No description.
availabilityZoneInput java.lang.String No description.
caCertIdentifierInput java.lang.String No description.
certificateRotationRestartInput java.lang.String No description.
clusterIdentifierInput java.lang.String No description.
copyTagsToSnapshotInput java.lang.Boolean|io.cdktn.cdktn.IResolvable No description.
enablePerformanceInsightsInput java.lang.Boolean|io.cdktn.cdktn.IResolvable No description.
engineInput java.lang.String No description.
identifierInput java.lang.String No description.
identifierPrefixInput java.lang.String No description.
idInput java.lang.String No description.
instanceClassInput java.lang.String No description.
performanceInsightsKmsKeyIdInput java.lang.String No description.
preferredMaintenanceWindowInput java.lang.String No description.
promotionTierInput java.lang.Number No description.
regionInput java.lang.String No description.
tagsAllInput java.util.Map<java.lang.String, java.lang.String> No description.
tagsInput java.util.Map<java.lang.String, java.lang.String> No description.
timeoutsInput io.cdktn.cdktn.IResolvable|DocdbClusterInstanceTimeouts No description.
applyImmediately java.lang.Boolean|io.cdktn.cdktn.IResolvable No description.
autoMinorVersionUpgrade java.lang.Boolean|io.cdktn.cdktn.IResolvable No description.
availabilityZone java.lang.String No description.
caCertIdentifier java.lang.String No description.
certificateRotationRestart java.lang.String No description.
clusterIdentifier java.lang.String No description.
copyTagsToSnapshot java.lang.Boolean|io.cdktn.cdktn.IResolvable No description.
enablePerformanceInsights java.lang.Boolean|io.cdktn.cdktn.IResolvable No description.
engine java.lang.String No description.
id java.lang.String No description.
identifier java.lang.String No description.
identifierPrefix java.lang.String No description.
instanceClass java.lang.String No description.
performanceInsightsKmsKeyId java.lang.String No description.
preferredMaintenanceWindow java.lang.String No description.
promotionTier java.lang.Number No description.
region java.lang.String No description.
tags java.util.Map<java.lang.String, java.lang.String> No description.
tagsAll java.util.Map<java.lang.String, java.lang.String> No description.
nodeRequired 
public Node getNode();
  • Type: software.constructs.Node

The tree node.

cdktfStackRequired 
public TerraformStack getCdktfStack();
  • Type: io.cdktn.cdktn.TerraformStack
fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
friendlyUniqueIdRequired 
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String
terraformMetaArgumentsRequired 
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>
terraformResourceTypeRequired 
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String
terraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: io.cdktn.cdktn.TerraformProviderGeneratorMetadata
connectionOptional 
public SSHProvisionerConnection|WinrmProvisionerConnection getConnection();
  • Type: io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection
countOptional 
public java.lang.Number|TerraformCount getCount();
  • Type: java.lang.Number|io.cdktn.cdktn.TerraformCount
dependsOnOptional 
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: io.cdktn.cdktn.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: io.cdktn.cdktn.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: io.cdktn.cdktn.TerraformProvider
provisionersOptional 
public java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner> getProvisioners();
  • Type: java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner>
arnRequired 
public java.lang.String getArn();
  • Type: java.lang.String
dbiResourceIdRequired 
public java.lang.String getDbiResourceId();
  • Type: java.lang.String
dbSubnetGroupNameRequired 
public java.lang.String getDbSubnetGroupName();
  • Type: java.lang.String
endpointRequired 
public java.lang.String getEndpoint();
  • Type: java.lang.String
engineVersionRequired 
public java.lang.String getEngineVersion();
  • Type: java.lang.String
kmsKeyIdRequired 
public java.lang.String getKmsKeyId();
  • Type: java.lang.String
portRequired 
public java.lang.Number getPort();
  • Type: java.lang.Number
preferredBackupWindowRequired 
public java.lang.String getPreferredBackupWindow();
  • Type: java.lang.String
publiclyAccessibleRequired 
public IResolvable getPubliclyAccessible();
  • Type: io.cdktn.cdktn.IResolvable
storageEncryptedRequired 
public IResolvable getStorageEncrypted();
  • Type: io.cdktn.cdktn.IResolvable
timeoutsRequired 
public DocdbClusterInstanceTimeoutsOutputReference getTimeouts();
writerRequired 
public IResolvable getWriter();
  • Type: io.cdktn.cdktn.IResolvable
applyImmediatelyInputOptional 
public java.lang.Boolean|IResolvable getApplyImmediatelyInput();
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable
autoMinorVersionUpgradeInputOptional 
public java.lang.Boolean|IResolvable getAutoMinorVersionUpgradeInput();
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable
availabilityZoneInputOptional 
public java.lang.String getAvailabilityZoneInput();
  • Type: java.lang.String
caCertIdentifierInputOptional 
public java.lang.String getCaCertIdentifierInput();
  • Type: java.lang.String
certificateRotationRestartInputOptional 
public java.lang.String getCertificateRotationRestartInput();
  • Type: java.lang.String
clusterIdentifierInputOptional 
public java.lang.String getClusterIdentifierInput();
  • Type: java.lang.String
copyTagsToSnapshotInputOptional 
public java.lang.Boolean|IResolvable getCopyTagsToSnapshotInput();
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable
enablePerformanceInsightsInputOptional 
public java.lang.Boolean|IResolvable getEnablePerformanceInsightsInput();
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable
engineInputOptional 
public java.lang.String getEngineInput();
  • Type: java.lang.String
identifierInputOptional 
public java.lang.String getIdentifierInput();
  • Type: java.lang.String
identifierPrefixInputOptional 
public java.lang.String getIdentifierPrefixInput();
  • Type: java.lang.String
idInputOptional 
public java.lang.String getIdInput();
  • Type: java.lang.String
instanceClassInputOptional 
public java.lang.String getInstanceClassInput();
  • Type: java.lang.String
performanceInsightsKmsKeyIdInputOptional 
public java.lang.String getPerformanceInsightsKmsKeyIdInput();
  • Type: java.lang.String
preferredMaintenanceWindowInputOptional 
public java.lang.String getPreferredMaintenanceWindowInput();
  • Type: java.lang.String
promotionTierInputOptional 
public java.lang.Number getPromotionTierInput();
  • Type: java.lang.Number
regionInputOptional 
public java.lang.String getRegionInput();
  • Type: java.lang.String
tagsAllInputOptional 
public java.util.Map<java.lang.String, java.lang.String> getTagsAllInput();
  • Type: java.util.Map<java.lang.String, java.lang.String>
tagsInputOptional 
public java.util.Map<java.lang.String, java.lang.String> getTagsInput();
  • Type: java.util.Map<java.lang.String, java.lang.String>
timeoutsInputOptional 
public IResolvable|DocdbClusterInstanceTimeouts getTimeoutsInput();
applyImmediatelyRequired 
public java.lang.Boolean|IResolvable getApplyImmediately();
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable
autoMinorVersionUpgradeRequired 
public java.lang.Boolean|IResolvable getAutoMinorVersionUpgrade();
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable
availabilityZoneRequired 
public java.lang.String getAvailabilityZone();
  • Type: java.lang.String
caCertIdentifierRequired 
public java.lang.String getCaCertIdentifier();
  • Type: java.lang.String
certificateRotationRestartRequired 
public java.lang.String getCertificateRotationRestart();
  • Type: java.lang.String
clusterIdentifierRequired 
public java.lang.String getClusterIdentifier();
  • Type: java.lang.String
copyTagsToSnapshotRequired 
public java.lang.Boolean|IResolvable getCopyTagsToSnapshot();
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable
enablePerformanceInsightsRequired 
public java.lang.Boolean|IResolvable getEnablePerformanceInsights();
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable
engineRequired 
public java.lang.String getEngine();
  • Type: java.lang.String
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
identifierRequired 
public java.lang.String getIdentifier();
  • Type: java.lang.String
identifierPrefixRequired 
public java.lang.String getIdentifierPrefix();
  • Type: java.lang.String
instanceClassRequired 
public java.lang.String getInstanceClass();
  • Type: java.lang.String
performanceInsightsKmsKeyIdRequired 
public java.lang.String getPerformanceInsightsKmsKeyId();
  • Type: java.lang.String
preferredMaintenanceWindowRequired 
public java.lang.String getPreferredMaintenanceWindow();
  • Type: java.lang.String
promotionTierRequired 
public java.lang.Number getPromotionTier();
  • Type: java.lang.Number
regionRequired 
public java.lang.String getRegion();
  • Type: java.lang.String
tagsRequired 
public java.util.Map<java.lang.String, java.lang.String> getTags();
  • Type: java.util.Map<java.lang.String, java.lang.String>
tagsAllRequired 
public java.util.Map<java.lang.String, java.lang.String> getTagsAll();
  • Type: java.util.Map<java.lang.String, java.lang.String>

Constants

Name Type Description
tfResourceType java.lang.String No description.
tfResourceTypeRequired 
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

DocdbClusterInstanceConfig

Initializer 

import io.cdktn.providers.aws.docdb_cluster_instance.DocdbClusterInstanceConfig;

DocdbClusterInstanceConfig.builder()
//  .connection(SSHProvisionerConnection|WinrmProvisionerConnection)
//  .count(java.lang.Number|TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner>)
    .clusterIdentifier(java.lang.String)
    .instanceClass(java.lang.String)
//  .applyImmediately(java.lang.Boolean|IResolvable)
//  .autoMinorVersionUpgrade(java.lang.Boolean|IResolvable)
//  .availabilityZone(java.lang.String)
//  .caCertIdentifier(java.lang.String)
//  .certificateRotationRestart(java.lang.String)
//  .copyTagsToSnapshot(java.lang.Boolean|IResolvable)
//  .enablePerformanceInsights(java.lang.Boolean|IResolvable)
//  .engine(java.lang.String)
//  .id(java.lang.String)
//  .identifier(java.lang.String)
//  .identifierPrefix(java.lang.String)
//  .performanceInsightsKmsKeyId(java.lang.String)
//  .preferredMaintenanceWindow(java.lang.String)
//  .promotionTier(java.lang.Number)
//  .region(java.lang.String)
//  .tags(java.util.Map<java.lang.String, java.lang.String>)
//  .tagsAll(java.util.Map<java.lang.String, java.lang.String>)
//  .timeouts(DocdbClusterInstanceTimeouts)
    .build();

Properties

Name Type Description
connection io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection No description.
count java.lang.Number|io.cdktn.cdktn.TerraformCount No description.
dependsOn java.util.List<io.cdktn.cdktn.ITerraformDependable> No description.
forEach io.cdktn.cdktn.ITerraformIterator No description.
lifecycle io.cdktn.cdktn.TerraformResourceLifecycle No description.
provider io.cdktn.cdktn.TerraformProvider No description.
provisioners java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner> No description.
clusterIdentifier java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#cluster_identifier DocdbClusterInstance#cluster_identifier}.
instanceClass java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#instance_class DocdbClusterInstance#instance_class}.
applyImmediately java.lang.Boolean|io.cdktn.cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#apply_immediately DocdbClusterInstance#apply_immediately}.
autoMinorVersionUpgrade java.lang.Boolean|io.cdktn.cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#auto_minor_version_upgrade DocdbClusterInstance#auto_minor_version_upgrade}.
availabilityZone java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#availability_zone DocdbClusterInstance#availability_zone}.
caCertIdentifier java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#ca_cert_identifier DocdbClusterInstance#ca_cert_identifier}.
certificateRotationRestart java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#certificate_rotation_restart DocdbClusterInstance#certificate_rotation_restart}.
copyTagsToSnapshot java.lang.Boolean|io.cdktn.cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#copy_tags_to_snapshot DocdbClusterInstance#copy_tags_to_snapshot}.
enablePerformanceInsights java.lang.Boolean|io.cdktn.cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#enable_performance_insights DocdbClusterInstance#enable_performance_insights}.
engine java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#engine DocdbClusterInstance#engine}.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#id DocdbClusterInstance#id}.
identifier java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#identifier DocdbClusterInstance#identifier}.
identifierPrefix java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#identifier_prefix DocdbClusterInstance#identifier_prefix}.
performanceInsightsKmsKeyId java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#performance_insights_kms_key_id DocdbClusterInstance#performance_insights_kms_key_id}.
preferredMaintenanceWindow java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#preferred_maintenance_window DocdbClusterInstance#preferred_maintenance_window}.
promotionTier java.lang.Number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#promotion_tier DocdbClusterInstance#promotion_tier}.
region java.lang.String Region where this resource will be managed. Defaults to the Region set in the provider configuration.
tags java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#tags DocdbClusterInstance#tags}.
tagsAll java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#tags_all DocdbClusterInstance#tags_all}.
timeouts DocdbClusterInstanceTimeouts timeouts block.
connectionOptional 
public SSHProvisionerConnection|WinrmProvisionerConnection getConnection();
  • Type: io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection
countOptional 
public java.lang.Number|TerraformCount getCount();
  • Type: java.lang.Number|io.cdktn.cdktn.TerraformCount
dependsOnOptional 
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<io.cdktn.cdktn.ITerraformDependable>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: io.cdktn.cdktn.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: io.cdktn.cdktn.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: io.cdktn.cdktn.TerraformProvider
provisionersOptional 
public java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner> getProvisioners();
  • Type: java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner>
clusterIdentifierRequired 
public java.lang.String getClusterIdentifier();
  • Type: java.lang.String

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

instanceClassRequired 
public java.lang.String getInstanceClass();
  • Type: java.lang.String

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

applyImmediatelyOptional 
public java.lang.Boolean|IResolvable getApplyImmediately();
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

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

autoMinorVersionUpgradeOptional 
public java.lang.Boolean|IResolvable getAutoMinorVersionUpgrade();
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

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

availabilityZoneOptional 
public java.lang.String getAvailabilityZone();
  • Type: java.lang.String

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

caCertIdentifierOptional 
public java.lang.String getCaCertIdentifier();
  • Type: java.lang.String

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

certificateRotationRestartOptional 
public java.lang.String getCertificateRotationRestart();
  • Type: java.lang.String

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

copyTagsToSnapshotOptional 
public java.lang.Boolean|IResolvable getCopyTagsToSnapshot();
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

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

enablePerformanceInsightsOptional 
public java.lang.Boolean|IResolvable getEnablePerformanceInsights();
  • Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

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

engineOptional 
public java.lang.String getEngine();
  • Type: java.lang.String

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

idOptional 
public java.lang.String getId();
  • Type: java.lang.String

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

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

identifierOptional 
public java.lang.String getIdentifier();
  • Type: java.lang.String

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

identifierPrefixOptional 
public java.lang.String getIdentifierPrefix();
  • Type: java.lang.String

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

performanceInsightsKmsKeyIdOptional 
public java.lang.String getPerformanceInsightsKmsKeyId();
  • Type: java.lang.String

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

preferredMaintenanceWindowOptional 
public java.lang.String getPreferredMaintenanceWindow();
  • Type: java.lang.String

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

promotionTierOptional 
public java.lang.Number getPromotionTier();
  • Type: java.lang.Number

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

regionOptional 
public java.lang.String getRegion();
  • Type: java.lang.String

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

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

tagsOptional 
public java.util.Map<java.lang.String, java.lang.String> getTags();
  • Type: java.util.Map<java.lang.String, java.lang.String>

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

tagsAllOptional 
public java.util.Map<java.lang.String, java.lang.String> getTagsAll();
  • Type: java.util.Map<java.lang.String, java.lang.String>

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

timeoutsOptional 
public DocdbClusterInstanceTimeouts getTimeouts();

timeouts block.

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

DocdbClusterInstanceTimeouts

Initializer 

import io.cdktn.providers.aws.docdb_cluster_instance.DocdbClusterInstanceTimeouts;

DocdbClusterInstanceTimeouts.builder()
//  .create(java.lang.String)
//  .delete(java.lang.String)
//  .update(java.lang.String)
    .build();

Properties

Name Type Description
create java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#create DocdbClusterInstance#create}.
delete java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#delete DocdbClusterInstance#delete}.
update java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/docdb_cluster_instance#update DocdbClusterInstance#update}.
createOptional 
public java.lang.String getCreate();
  • Type: java.lang.String

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

deleteOptional 
public java.lang.String getDelete();
  • Type: java.lang.String

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

updateOptional 
public java.lang.String getUpdate();
  • Type: java.lang.String

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

Classes

DocdbClusterInstanceTimeoutsOutputReference

Initializers 

import io.cdktn.providers.aws.docdb_cluster_instance.DocdbClusterInstanceTimeoutsOutputReference;

new DocdbClusterInstanceTimeoutsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
Name Type Description
terraformResource io.cdktn.cdktn.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: io.cdktn.cdktn.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.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 java.lang.String computeFqn()
getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: io.cdktn.cdktn.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetCreate 
public void resetCreate()
resetDelete 
public void resetDelete()
resetUpdate 
public void resetUpdate()

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
createInput java.lang.String No description.
deleteInput java.lang.String No description.
updateInput java.lang.String No description.
create java.lang.String No description.
delete java.lang.String No description.
update java.lang.String No description.
internalValue io.cdktn.cdktn.IResolvable|DocdbClusterInstanceTimeouts No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.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.

fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
createInputOptional 
public java.lang.String getCreateInput();
  • Type: java.lang.String
deleteInputOptional 
public java.lang.String getDeleteInput();
  • Type: java.lang.String
updateInputOptional 
public java.lang.String getUpdateInput();
  • Type: java.lang.String
createRequired 
public java.lang.String getCreate();
  • Type: java.lang.String
deleteRequired 
public java.lang.String getDelete();
  • Type: java.lang.String
updateRequired 
public java.lang.String getUpdate();
  • Type: java.lang.String
internalValueOptional 
public IResolvable|DocdbClusterInstanceTimeouts getInternalValue();