`dataAwsDbInstance` Submodule

Constructs

DataAwsDbInstance

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/db_instance aws_db_instance}.

Initializers

import com.hashicorp.cdktf.providers.aws.data_aws_db_instance.DataAwsDbInstance;

DataAwsDbInstance.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
//  .dbInstanceIdentifier(java.lang.String)
//  .id(java.lang.String)
//  .tags(java.util.Map<java.lang.String, java.lang.String>)
    .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`	`com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection`	No description.
`count`	`java.lang.Number OR com.hashicorp.cdktf.TerraformCount`	No description.
`dependsOn`	`java.util.List<com.hashicorp.cdktf.ITerraformDependable>`	No description.
`forEach`	`com.hashicorp.cdktf.ITerraformIterator`	No description.
`lifecycle`	`com.hashicorp.cdktf.TerraformResourceLifecycle`	No description.
`provider`	`com.hashicorp.cdktf.TerraformProvider`	No description.
`provisioners`	`java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>`	No description.
`dbInstanceIdentifier`	`java.lang.String`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/db_instance#db_instance_identifier DataAwsDbInstance#db_instance_identifier}.
`id`	`java.lang.String`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/db_instance#id DataAwsDbInstance#id}.
`tags`	`java.util.Map<java.lang.String, java.lang.String>`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/db_instance#tags DataAwsDbInstance#tags}.

`scope`^Required

Type: software.constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

`connection`^Optional

Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection

`count`^Optional

Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount

`dependsOn`^Optional

Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>

`forEach`^Optional

Type: com.hashicorp.cdktf.ITerraformIterator

`lifecycle`^Optional

Type: com.hashicorp.cdktf.TerraformResourceLifecycle

`provider`^Optional

Type: com.hashicorp.cdktf.TerraformProvider

`provisioners`^Optional

Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>

`dbInstanceIdentifier`^Optional

Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/db_instance#db_instance_identifier DataAwsDbInstance#db_instance_identifier}.

`id`^Optional

Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/db_instance#id DataAwsDbInstance#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.

`tags`^Optional

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/db_instance#tags DataAwsDbInstance#tags}.

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`	Adds this resource to the terraform JSON output.
`toMetadata`	No description.
`toTerraform`	Adds this resource to the terraform JSON output.
`getAnyMapAttribute`	No description.
`getBooleanAttribute`	No description.
`getBooleanMapAttribute`	No description.
`getListAttribute`	No description.
`getNumberAttribute`	No description.
`getNumberListAttribute`	No description.
`getNumberMapAttribute`	No description.
`getStringAttribute`	No description.
`getStringMapAttribute`	No description.
`interpolationForAttribute`	No description.
`resetDbInstanceIdentifier`	No description.
`resetId`	No description.
`resetTags`	No description.

`toString`

public java.lang.String toString()

Returns a string representation of this construct.

`addOverride`

public void addOverride(java.lang.String path, java.lang.Object value)

`path`^Required

Type: java.lang.String

`value`^Required

Type: java.lang.Object

`overrideLogicalId`

public void overrideLogicalId(java.lang.String newLogicalId)

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

`newLogicalId`^Required

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()

Adds this resource to the terraform JSON output.

`toMetadata`

public java.lang.Object toMetadata()

`toTerraform`

public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

`getAnyMapAttribute`

public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getBooleanAttribute`

public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getBooleanMapAttribute`

public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getListAttribute`

public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getNumberAttribute`

public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getNumberListAttribute`

public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getNumberMapAttribute`

public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getStringAttribute`

public java.lang.String getStringAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getStringMapAttribute`

public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`interpolationForAttribute`

public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`resetDbInstanceIdentifier`

public void resetDbInstanceIdentifier()

`resetId`

public void resetId()

`resetTags`

public void resetTags()

Static Functions

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

`isConstruct`

import com.hashicorp.cdktf.providers.aws.data_aws_db_instance.DataAwsDbInstance;

DataAwsDbInstance.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.

`x`^Required

Type: java.lang.Object

Any object.

`isTerraformElement`

import com.hashicorp.cdktf.providers.aws.data_aws_db_instance.DataAwsDbInstance;

DataAwsDbInstance.isTerraformElement(java.lang.Object x)

`x`^Required

Type: java.lang.Object

`isTerraformDataSource`

import com.hashicorp.cdktf.providers.aws.data_aws_db_instance.DataAwsDbInstance;

DataAwsDbInstance.isTerraformDataSource(java.lang.Object x)

`x`^Required

Type: java.lang.Object

`generateConfigForImport`

import com.hashicorp.cdktf.providers.aws.data_aws_db_instance.DataAwsDbInstance;

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

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

`scope`^Required

Type: software.constructs.Construct

The scope in which to define this construct.

`importToId`^Required

Type: java.lang.String

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

`importFromId`^Required

Type: java.lang.String

The id of the existing DataAwsDbInstance that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/db_instance#import import section} in the documentation of this resource for the id to use

`provider`^Optional

Type: com.hashicorp.cdktf.TerraformProvider

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

Properties

Name	Type	Description
`node`	`software.constructs.Node`	The tree node.
`cdktfStack`	`com.hashicorp.cdktf.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`	`com.hashicorp.cdktf.TerraformProviderGeneratorMetadata`	No description.
`count`	`java.lang.Number OR com.hashicorp.cdktf.TerraformCount`	No description.
`dependsOn`	`java.util.List<java.lang.String>`	No description.
`forEach`	`com.hashicorp.cdktf.ITerraformIterator`	No description.
`lifecycle`	`com.hashicorp.cdktf.TerraformResourceLifecycle`	No description.
`provider`	`com.hashicorp.cdktf.TerraformProvider`	No description.
`address`	`java.lang.String`	No description.
`allocatedStorage`	`java.lang.Number`	No description.
`autoMinorVersionUpgrade`	`com.hashicorp.cdktf.IResolvable`	No description.
`availabilityZone`	`java.lang.String`	No description.
`backupRetentionPeriod`	`java.lang.Number`	No description.
`caCertIdentifier`	`java.lang.String`	No description.
`dbClusterIdentifier`	`java.lang.String`	No description.
`dbInstanceArn`	`java.lang.String`	No description.
`dbInstanceClass`	`java.lang.String`	No description.
`dbInstancePort`	`java.lang.Number`	No description.
`dbName`	`java.lang.String`	No description.
`dbParameterGroups`	`java.util.List<java.lang.String>`	No description.
`dbSubnetGroup`	`java.lang.String`	No description.
`enabledCloudwatchLogsExports`	`java.util.List<java.lang.String>`	No description.
`endpoint`	`java.lang.String`	No description.
`engine`	`java.lang.String`	No description.
`engineVersion`	`java.lang.String`	No description.
`hostedZoneId`	`java.lang.String`	No description.
`iops`	`java.lang.Number`	No description.
`kmsKeyId`	`java.lang.String`	No description.
`licenseModel`	`java.lang.String`	No description.
`masterUsername`	`java.lang.String`	No description.
`masterUserSecret`	`DataAwsDbInstanceMasterUserSecretList`	No description.
`maxAllocatedStorage`	`java.lang.Number`	No description.
`monitoringInterval`	`java.lang.Number`	No description.
`monitoringRoleArn`	`java.lang.String`	No description.
`multiAz`	`com.hashicorp.cdktf.IResolvable`	No description.
`networkType`	`java.lang.String`	No description.
`optionGroupMemberships`	`java.util.List<java.lang.String>`	No description.
`port`	`java.lang.Number`	No description.
`preferredBackupWindow`	`java.lang.String`	No description.
`preferredMaintenanceWindow`	`java.lang.String`	No description.
`publiclyAccessible`	`com.hashicorp.cdktf.IResolvable`	No description.
`replicateSourceDb`	`java.lang.String`	No description.
`resourceId`	`java.lang.String`	No description.
`storageEncrypted`	`com.hashicorp.cdktf.IResolvable`	No description.
`storageThroughput`	`java.lang.Number`	No description.
`storageType`	`java.lang.String`	No description.
`timezone`	`java.lang.String`	No description.
`vpcSecurityGroups`	`java.util.List<java.lang.String>`	No description.
`dbInstanceIdentifierInput`	`java.lang.String`	No description.
`idInput`	`java.lang.String`	No description.
`tagsInput`	`java.util.Map<java.lang.String, java.lang.String>`	No description.
`dbInstanceIdentifier`	`java.lang.String`	No description.
`id`	`java.lang.String`	No description.
`tags`	`java.util.Map<java.lang.String, java.lang.String>`	No description.

`node`^Required

public Node getNode();

Type: software.constructs.Node

The tree node.

`cdktfStack`^Required

public TerraformStack getCdktfStack();

Type: com.hashicorp.cdktf.TerraformStack

`fqn`^Required

public java.lang.String getFqn();

Type: java.lang.String

`friendlyUniqueId`^Required

public java.lang.String getFriendlyUniqueId();

Type: java.lang.String

`terraformMetaArguments`^Required

public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();

Type: java.util.Map<java.lang.String, java.lang.Object>

`terraformResourceType`^Required

public java.lang.String getTerraformResourceType();

Type: java.lang.String

`terraformGeneratorMetadata`^Optional

public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();

Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata

`count`^Optional

public java.lang.Object getCount();

Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount

`dependsOn`^Optional

public java.util.List<java.lang.String> getDependsOn();

Type: java.util.List<java.lang.String>

`forEach`^Optional

public ITerraformIterator getForEach();

Type: com.hashicorp.cdktf.ITerraformIterator

`lifecycle`^Optional

public TerraformResourceLifecycle getLifecycle();

Type: com.hashicorp.cdktf.TerraformResourceLifecycle

`provider`^Optional

public TerraformProvider getProvider();

Type: com.hashicorp.cdktf.TerraformProvider

`address`^Required

public java.lang.String getAddress();

Type: java.lang.String

`allocatedStorage`^Required

public java.lang.Number getAllocatedStorage();

Type: java.lang.Number

`autoMinorVersionUpgrade`^Required

public IResolvable getAutoMinorVersionUpgrade();

Type: com.hashicorp.cdktf.IResolvable

`availabilityZone`^Required

public java.lang.String getAvailabilityZone();

Type: java.lang.String

`backupRetentionPeriod`^Required

public java.lang.Number getBackupRetentionPeriod();

Type: java.lang.Number

`caCertIdentifier`^Required

public java.lang.String getCaCertIdentifier();

Type: java.lang.String

`dbClusterIdentifier`^Required

public java.lang.String getDbClusterIdentifier();

Type: java.lang.String

`dbInstanceArn`^Required

public java.lang.String getDbInstanceArn();

Type: java.lang.String

`dbInstanceClass`^Required

public java.lang.String getDbInstanceClass();

Type: java.lang.String

`dbInstancePort`^Required

public java.lang.Number getDbInstancePort();

Type: java.lang.Number

`dbName`^Required

public java.lang.String getDbName();

Type: java.lang.String

`dbParameterGroups`^Required

public java.util.List<java.lang.String> getDbParameterGroups();

Type: java.util.List<java.lang.String>

`dbSubnetGroup`^Required

public java.lang.String getDbSubnetGroup();

Type: java.lang.String

`enabledCloudwatchLogsExports`^Required

public java.util.List<java.lang.String> getEnabledCloudwatchLogsExports();

Type: java.util.List<java.lang.String>

`endpoint`^Required

public java.lang.String getEndpoint();

Type: java.lang.String

`engine`^Required

public java.lang.String getEngine();

Type: java.lang.String

`engineVersion`^Required

public java.lang.String getEngineVersion();

Type: java.lang.String

`hostedZoneId`^Required

public java.lang.String getHostedZoneId();

Type: java.lang.String

`iops`^Required

public java.lang.Number getIops();

Type: java.lang.Number

`kmsKeyId`^Required

public java.lang.String getKmsKeyId();

Type: java.lang.String

`licenseModel`^Required

public java.lang.String getLicenseModel();

Type: java.lang.String

`masterUsername`^Required

public java.lang.String getMasterUsername();

Type: java.lang.String

`masterUserSecret`^Required

public DataAwsDbInstanceMasterUserSecretList getMasterUserSecret();

Type: DataAwsDbInstanceMasterUserSecretList

`maxAllocatedStorage`^Required

public java.lang.Number getMaxAllocatedStorage();

Type: java.lang.Number

`monitoringInterval`^Required

public java.lang.Number getMonitoringInterval();

Type: java.lang.Number

`monitoringRoleArn`^Required

public java.lang.String getMonitoringRoleArn();

Type: java.lang.String

`multiAz`^Required

public IResolvable getMultiAz();

Type: com.hashicorp.cdktf.IResolvable

`networkType`^Required

public java.lang.String getNetworkType();

Type: java.lang.String

`optionGroupMemberships`^Required

public java.util.List<java.lang.String> getOptionGroupMemberships();

Type: java.util.List<java.lang.String>

`port`^Required

public java.lang.Number getPort();

Type: java.lang.Number

`preferredBackupWindow`^Required

public java.lang.String getPreferredBackupWindow();

Type: java.lang.String

`preferredMaintenanceWindow`^Required

public java.lang.String getPreferredMaintenanceWindow();

Type: java.lang.String

`publiclyAccessible`^Required

public IResolvable getPubliclyAccessible();

Type: com.hashicorp.cdktf.IResolvable

`replicateSourceDb`^Required

public java.lang.String getReplicateSourceDb();

Type: java.lang.String

`resourceId`^Required

public java.lang.String getResourceId();

Type: java.lang.String

`storageEncrypted`^Required

public IResolvable getStorageEncrypted();

Type: com.hashicorp.cdktf.IResolvable

`storageThroughput`^Required

public java.lang.Number getStorageThroughput();

Type: java.lang.Number

`storageType`^Required

public java.lang.String getStorageType();

Type: java.lang.String

`timezone`^Required

public java.lang.String getTimezone();

Type: java.lang.String

`vpcSecurityGroups`^Required

public java.util.List<java.lang.String> getVpcSecurityGroups();

Type: java.util.List<java.lang.String>

`dbInstanceIdentifierInput`^Optional

public java.lang.String getDbInstanceIdentifierInput();

Type: java.lang.String

`idInput`^Optional

public java.lang.String getIdInput();

Type: java.lang.String

`tagsInput`^Optional

public java.util.Map<java.lang.String, java.lang.String> getTagsInput();

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

`dbInstanceIdentifier`^Required

public java.lang.String getDbInstanceIdentifier();

Type: java.lang.String

`id`^Required

public java.lang.String getId();

Type: java.lang.String

`tags`^Required

public java.util.Map<java.lang.String, java.lang.String> getTags();

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

Constants

Name	Type	Description
`tfResourceType`	`java.lang.String`	No description.

`tfResourceType`^Required

public java.lang.String getTfResourceType();

Type: java.lang.String

Structs

DataAwsDbInstanceConfig

Initializer

import com.hashicorp.cdktf.providers.aws.data_aws_db_instance.DataAwsDbInstanceConfig;

DataAwsDbInstanceConfig.builder()
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
//  .dbInstanceIdentifier(java.lang.String)
//  .id(java.lang.String)
//  .tags(java.util.Map<java.lang.String, java.lang.String>)
    .build();

Properties

Name	Type	Description
`connection`	`com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection`	No description.
`count`	`java.lang.Number OR com.hashicorp.cdktf.TerraformCount`	No description.
`dependsOn`	`java.util.List<com.hashicorp.cdktf.ITerraformDependable>`	No description.
`forEach`	`com.hashicorp.cdktf.ITerraformIterator`	No description.
`lifecycle`	`com.hashicorp.cdktf.TerraformResourceLifecycle`	No description.
`provider`	`com.hashicorp.cdktf.TerraformProvider`	No description.
`provisioners`	`java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>`	No description.
`dbInstanceIdentifier`	`java.lang.String`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/db_instance#db_instance_identifier DataAwsDbInstance#db_instance_identifier}.
`id`	`java.lang.String`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/db_instance#id DataAwsDbInstance#id}.
`tags`	`java.util.Map<java.lang.String, java.lang.String>`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/db_instance#tags DataAwsDbInstance#tags}.

`connection`^Optional

public java.lang.Object getConnection();

Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection

`count`^Optional

public java.lang.Object getCount();

Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount

`dependsOn`^Optional

public java.util.List<ITerraformDependable> getDependsOn();

Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>

`forEach`^Optional

public ITerraformIterator getForEach();

Type: com.hashicorp.cdktf.ITerraformIterator

`lifecycle`^Optional

public TerraformResourceLifecycle getLifecycle();

Type: com.hashicorp.cdktf.TerraformResourceLifecycle

`provider`^Optional

public TerraformProvider getProvider();

Type: com.hashicorp.cdktf.TerraformProvider

`provisioners`^Optional

public java.lang.Object getProvisioners();

Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>

`dbInstanceIdentifier`^Optional

public java.lang.String getDbInstanceIdentifier();

Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/db_instance#db_instance_identifier DataAwsDbInstance#db_instance_identifier}.

`id`^Optional

public java.lang.String getId();

Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.79.0/docs/data-sources/db_instance#id DataAwsDbInstance#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.

`tags`^Optional

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/5.79.0/docs/data-sources/db_instance#tags DataAwsDbInstance#tags}.

DataAwsDbInstanceMasterUserSecret

Initializer

import com.hashicorp.cdktf.providers.aws.data_aws_db_instance.DataAwsDbInstanceMasterUserSecret;

DataAwsDbInstanceMasterUserSecret.builder()
    .build();

Classes

DataAwsDbInstanceMasterUserSecretList

Initializers

import com.hashicorp.cdktf.providers.aws.data_aws_db_instance.DataAwsDbInstanceMasterUserSecretList;

new DataAwsDbInstanceMasterUserSecretList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet);

Name	Type	Description
`terraformResource`	`com.hashicorp.cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`java.lang.String`	The attribute on the parent resource this class is referencing.
`wrapsSet`	`java.lang.Boolean`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`terraformResource`^Required

Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: java.lang.String

The attribute on the parent resource this class is referencing.

`wrapsSet`^Required

Type: java.lang.Boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name	Description
`allWithMapKey`	Creating an iterator for this complex list.
`computeFqn`	No description.
`resolve`	Produce the Token's value at resolution time.
`toString`	Return a string representation of this resolvable object.
`get`	No description.

`allWithMapKey`

public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName)

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

`mapKeyAttributeName`^Required

Type: java.lang.String

`computeFqn`

public java.lang.String computeFqn()

`resolve`

public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

`_context`^Required

Type: com.hashicorp.cdktf.IResolveContext

`toString`

public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

`get`

public DataAwsDbInstanceMasterUserSecretOutputReference get(java.lang.Number index)

`index`^Required

Type: java.lang.Number

the index of the item to return.

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.

`creationStack`^Required

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.

`fqn`^Required

public java.lang.String getFqn();

Type: java.lang.String

DataAwsDbInstanceMasterUserSecretOutputReference

Initializers

import com.hashicorp.cdktf.providers.aws.data_aws_db_instance.DataAwsDbInstanceMasterUserSecretOutputReference;

new DataAwsDbInstanceMasterUserSecretOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet);

Name	Type	Description
`terraformResource`	`com.hashicorp.cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`java.lang.String`	The attribute on the parent resource this class is referencing.
`complexObjectIndex`	`java.lang.Number`	the index of this item in the list.
`complexObjectIsFromSet`	`java.lang.Boolean`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`terraformResource`^Required

Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: java.lang.String

The attribute on the parent resource this class is referencing.

`complexObjectIndex`^Required

Type: java.lang.Number

the index of this item in the list.

`complexObjectIsFromSet`^Required

Type: java.lang.Boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

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.

`computeFqn`

public java.lang.String computeFqn()

`getAnyMapAttribute`

public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getBooleanAttribute`

public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getBooleanMapAttribute`

public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getListAttribute`

public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getNumberAttribute`

public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getNumberListAttribute`

public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getNumberMapAttribute`

public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getStringAttribute`

public java.lang.String getStringAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getStringMapAttribute`

public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`interpolationForAttribute`

public IResolvable interpolationForAttribute(java.lang.String property)

`property`^Required

Type: java.lang.String

`resolve`

public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

`_context`^Required

Type: com.hashicorp.cdktf.IResolveContext

`toString`

public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

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.
`kmsKeyId`	`java.lang.String`	No description.
`secretArn`	`java.lang.String`	No description.
`secretStatus`	`java.lang.String`	No description.
`internalValue`	`DataAwsDbInstanceMasterUserSecret`	No description.

`creationStack`^Required

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.

`fqn`^Required

public java.lang.String getFqn();

Type: java.lang.String

`kmsKeyId`^Required

public java.lang.String getKmsKeyId();

Type: java.lang.String

`secretArn`^Required

public java.lang.String getSecretArn();

Type: java.lang.String

`secretStatus`^Required

public java.lang.String getSecretStatus();

Type: java.lang.String

`internalValue`^Optional

public DataAwsDbInstanceMasterUserSecret getInternalValue();

Type: DataAwsDbInstanceMasterUserSecret

Files

dataAwsDbInstance.java.md

Latest commit

History

dataAwsDbInstance.java.md

File metadata and controls

dataAwsDbInstance Submodule

Constructs