dataAwsDbInstance.md

dataAwsDbInstance Submodule

Constructs

DataAwsDbInstance

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

Initializers

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

new dataAwsDbInstance.DataAwsDbInstance(scope: Construct, id: string, config: DataAwsDbInstanceConfig)

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

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

config^Required

• Type: DataAwsDbInstanceConfig

---

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.
resetId	No description.
resetTags	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

addOverride

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

path^Required

• Type: string

---

value^Required

• Type: any

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

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

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

resetOverrideLogicalId

public resetOverrideLogicalId(): void

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

toHclTerraform

public toHclTerraform(): any

Adds this resource to the terraform JSON output.

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

getAnyMapAttribute

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

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

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

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

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

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

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

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

resetId

public resetId(): void

resetTags

public resetTags(): void

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 { dataAwsDbInstance } from '@cdktf/aws-cdk'

dataAwsDbInstance.DataAwsDbInstance.isConstruct(x: any)

Checks if x is a construct.

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

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

x^Required

• Type: any

Any object.

---

isTerraformElement

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

dataAwsDbInstance.DataAwsDbInstance.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformDataSource

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

dataAwsDbInstance.DataAwsDbInstance.isTerraformDataSource(x: any)

x^Required

• Type: any

---

generateConfigForImport

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

dataAwsDbInstance.DataAwsDbInstance.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

---

importFromId^Required

• Type: string

The id of the existing DataAwsDbInstance that should be imported.

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

---

provider^Optional

• Type: cdktf.TerraformProvider

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

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
cdktfStack	cdktf.TerraformStack	No description.
fqn	string	No description.
friendlyUniqueId	string	No description.
terraformMetaArguments	{[ key: string ]: any}	No description.
terraformResourceType	string	No description.
terraformGeneratorMetadata	cdktf.TerraformProviderGeneratorMetadata	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	string[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
address	string	No description.
allocatedStorage	number	No description.
autoMinorVersionUpgrade	cdktf.IResolvable	No description.
availabilityZone	string	No description.
backupRetentionPeriod	number	No description.
caCertIdentifier	string	No description.
dbClusterIdentifier	string	No description.
dbInstanceArn	string	No description.
dbInstanceClass	string	No description.
dbInstancePort	number	No description.
dbName	string	No description.
dbParameterGroups	string[]	No description.
dbSecurityGroups	string[]	No description.
dbSubnetGroup	string	No description.
enabledCloudwatchLogsExports	string[]	No description.
endpoint	string	No description.
engine	string	No description.
engineVersion	string	No description.
hostedZoneId	string	No description.
iops	number	No description.
kmsKeyId	string	No description.
licenseModel	string	No description.
masterUsername	string	No description.
monitoringInterval	number	No description.
monitoringRoleArn	string	No description.
multiAz	cdktf.IResolvable	No description.
optionGroupMemberships	string[]	No description.
port	number	No description.
preferredBackupWindow	string	No description.
preferredMaintenanceWindow	string	No description.
publiclyAccessible	cdktf.IResolvable	No description.
replicateSourceDb	string	No description.
resourceId	string	No description.
storageEncrypted	cdktf.IResolvable	No description.
storageType	string	No description.
timezone	string	No description.
vpcSecurityGroups	string[]	No description.
dbInstanceIdentifierInput	string	No description.
idInput	string	No description.
tagsInput	{[ key: string ]: string}	No description.
dbInstanceIdentifier	string	No description.
id	string	No description.
tags	{[ key: string ]: string}	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktf.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

terraformMetaArguments^Required

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

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

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktf.TerraformProviderGeneratorMetadata

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

address^Required

public readonly address: string;

• Type: string

---

allocatedStorage^Required

public readonly allocatedStorage: number;

• Type: number

---

autoMinorVersionUpgrade^Required

public readonly autoMinorVersionUpgrade: IResolvable;

• Type: cdktf.IResolvable

---

availabilityZone^Required

public readonly availabilityZone: string;

• Type: string

---

backupRetentionPeriod^Required

public readonly backupRetentionPeriod: number;

• Type: number

---

caCertIdentifier^Required

public readonly caCertIdentifier: string;

• Type: string

---

dbClusterIdentifier^Required

public readonly dbClusterIdentifier: string;

• Type: string

---

dbInstanceArn^Required

public readonly dbInstanceArn: string;

• Type: string

---

dbInstanceClass^Required

public readonly dbInstanceClass: string;

• Type: string

---

dbInstancePort^Required

public readonly dbInstancePort: number;

• Type: number

---

dbName^Required

public readonly dbName: string;

• Type: string

---

dbParameterGroups^Required

public readonly dbParameterGroups: string[];

• Type: string[]

---

dbSecurityGroups^Required

public readonly dbSecurityGroups: string[];

• Type: string[]

---

dbSubnetGroup^Required

public readonly dbSubnetGroup: string;

• Type: string

---

enabledCloudwatchLogsExports^Required

public readonly enabledCloudwatchLogsExports: string[];

• Type: string[]

---

endpoint^Required

public readonly endpoint: string;

• Type: string

---

engine^Required

public readonly engine: string;

• Type: string

---

engineVersion^Required

public readonly engineVersion: string;

• Type: string

---

hostedZoneId^Required

public readonly hostedZoneId: string;

• Type: string

---

iops^Required

public readonly iops: number;

• Type: number

---

kmsKeyId^Required

public readonly kmsKeyId: string;

• Type: string

---

licenseModel^Required

public readonly licenseModel: string;

• Type: string

---

masterUsername^Required

public readonly masterUsername: string;

• Type: string

---

monitoringInterval^Required

public readonly monitoringInterval: number;

• Type: number

---

monitoringRoleArn^Required

public readonly monitoringRoleArn: string;

• Type: string

---

multiAz^Required

public readonly multiAz: IResolvable;

• Type: cdktf.IResolvable

---

optionGroupMemberships^Required

public readonly optionGroupMemberships: string[];

• Type: string[]

---

port^Required

public readonly port: number;

• Type: number

---

preferredBackupWindow^Required

public readonly preferredBackupWindow: string;

• Type: string

---

preferredMaintenanceWindow^Required

public readonly preferredMaintenanceWindow: string;

• Type: string

---

publiclyAccessible^Required

public readonly publiclyAccessible: IResolvable;

• Type: cdktf.IResolvable

---

replicateSourceDb^Required

public readonly replicateSourceDb: string;

• Type: string

---

resourceId^Required

public readonly resourceId: string;

• Type: string

---

storageEncrypted^Required

public readonly storageEncrypted: IResolvable;

• Type: cdktf.IResolvable

---

storageType^Required

public readonly storageType: string;

• Type: string

---

timezone^Required

public readonly timezone: string;

• Type: string

---

vpcSecurityGroups^Required

public readonly vpcSecurityGroups: string[];

• Type: string[]

---

dbInstanceIdentifierInput^Optional

public readonly dbInstanceIdentifierInput: string;

• Type: string

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

tagsInput^Optional

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

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

---

dbInstanceIdentifier^Required

public readonly dbInstanceIdentifier: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

tags^Required

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

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

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

DataAwsDbInstanceConfig

Initializer

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

const dataAwsDbInstanceConfig: dataAwsDbInstance.DataAwsDbInstanceConfig = { ... }

Properties

Name	Type	Description
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	cdktf.ITerraformDependable[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
dbInstanceIdentifier	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/db_instance#db_instance_identifier DataAwsDbInstance#db_instance_identifier}.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/db_instance#id DataAwsDbInstance#id}.
tags	{[ key: string ]: string}	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/db_instance#tags DataAwsDbInstance#tags}.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktf.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

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

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

---

dbInstanceIdentifier^Required

public readonly dbInstanceIdentifier: string;

• Type: string

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

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/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 readonly tags: {[ key: string ]: string};

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

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

---