dataAwsDbSnapshot.md

dataAwsDbSnapshot Submodule

Constructs

DataAwsDbSnapshot

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

Initializers

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

new dataAwsDbSnapshot.DataAwsDbSnapshot(scope: Construct, id: string, config?: DataAwsDbSnapshotConfig)

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

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

config^Optional

• Type: DataAwsDbSnapshotConfig

---

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.
resetDbSnapshotIdentifier	No description.
resetId	No description.
resetIncludePublic	No description.
resetIncludeShared	No description.
resetMostRecent	No description.
resetSnapshotType	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

---

resetDbInstanceIdentifier

public resetDbInstanceIdentifier(): void

resetDbSnapshotIdentifier

public resetDbSnapshotIdentifier(): void

resetId

public resetId(): void

resetIncludePublic

public resetIncludePublic(): void

resetIncludeShared

public resetIncludeShared(): void

resetMostRecent

public resetMostRecent(): void

resetSnapshotType

public resetSnapshotType(): 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 DataAwsDbSnapshot resource upon running "cdktf plan ".

---

isConstruct

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

dataAwsDbSnapshot.DataAwsDbSnapshot.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

isTerraformElement

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

dataAwsDbSnapshot.DataAwsDbSnapshot.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformDataSource

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

dataAwsDbSnapshot.DataAwsDbSnapshot.isTerraformDataSource(x: any)

x^Required

• Type: any

---

generateConfigForImport

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

dataAwsDbSnapshot.DataAwsDbSnapshot.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

---

importFromId^Required

• Type: string

The id of the existing DataAwsDbSnapshot that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/db_snapshot#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 DataAwsDbSnapshot 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.
allocatedStorage	number	No description.
availabilityZone	string	No description.
dbSnapshotArn	string	No description.
encrypted	cdktf.IResolvable	No description.
engine	string	No description.
engineVersion	string	No description.
iops	number	No description.
kmsKeyId	string	No description.
licenseModel	string	No description.
optionGroupName	string	No description.
port	number	No description.
snapshotCreateTime	string	No description.
sourceDbSnapshotIdentifier	string	No description.
sourceRegion	string	No description.
status	string	No description.
storageType	string	No description.
vpcId	string	No description.
dbInstanceIdentifierInput	string	No description.
dbSnapshotIdentifierInput	string	No description.
idInput	string	No description.
includePublicInput	boolean | cdktf.IResolvable	No description.
includeSharedInput	boolean | cdktf.IResolvable	No description.
mostRecentInput	boolean | cdktf.IResolvable	No description.
snapshotTypeInput	string	No description.
dbInstanceIdentifier	string	No description.
dbSnapshotIdentifier	string	No description.
id	string	No description.
includePublic	boolean | cdktf.IResolvable	No description.
includeShared	boolean | cdktf.IResolvable	No description.
mostRecent	boolean | cdktf.IResolvable	No description.
snapshotType	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

---

allocatedStorage^Required

public readonly allocatedStorage: number;

• Type: number

---

availabilityZone^Required

public readonly availabilityZone: string;

• Type: string

---

dbSnapshotArn^Required

public readonly dbSnapshotArn: string;

• Type: string

---

encrypted^Required

public readonly encrypted: IResolvable;

• Type: cdktf.IResolvable

---

engine^Required

public readonly engine: string;

• Type: string

---

engineVersion^Required

public readonly engineVersion: 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

---

optionGroupName^Required

public readonly optionGroupName: string;

• Type: string

---

port^Required

public readonly port: number;

• Type: number

---

snapshotCreateTime^Required

public readonly snapshotCreateTime: string;

• Type: string

---

sourceDbSnapshotIdentifier^Required

public readonly sourceDbSnapshotIdentifier: string;

• Type: string

---

sourceRegion^Required

public readonly sourceRegion: string;

• Type: string

---

status^Required

public readonly status: string;

• Type: string

---

storageType^Required

public readonly storageType: string;

• Type: string

---

vpcId^Required

public readonly vpcId: string;

• Type: string

---

dbInstanceIdentifierInput^Optional

public readonly dbInstanceIdentifierInput: string;

• Type: string

---

dbSnapshotIdentifierInput^Optional

public readonly dbSnapshotIdentifierInput: string;

• Type: string

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

includePublicInput^Optional

public readonly includePublicInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

includeSharedInput^Optional

public readonly includeSharedInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

mostRecentInput^Optional

public readonly mostRecentInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

snapshotTypeInput^Optional

public readonly snapshotTypeInput: string;

• Type: string

---

dbInstanceIdentifier^Required

public readonly dbInstanceIdentifier: string;

• Type: string

---

dbSnapshotIdentifier^Required

public readonly dbSnapshotIdentifier: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

includePublic^Required

public readonly includePublic: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

includeShared^Required

public readonly includeShared: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

mostRecent^Required

public readonly mostRecent: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

snapshotType^Required

public readonly snapshotType: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

DataAwsDbSnapshotConfig

Initializer

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

const dataAwsDbSnapshotConfig: dataAwsDbSnapshot.DataAwsDbSnapshotConfig = { ... }

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_snapshot#db_instance_identifier DataAwsDbSnapshot#db_instance_identifier}.
dbSnapshotIdentifier	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/db_snapshot#db_snapshot_identifier DataAwsDbSnapshot#db_snapshot_identifier}.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/db_snapshot#id DataAwsDbSnapshot#id}.
includePublic	boolean | cdktf.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/db_snapshot#include_public DataAwsDbSnapshot#include_public}.
includeShared	boolean | cdktf.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/db_snapshot#include_shared DataAwsDbSnapshot#include_shared}.
mostRecent	boolean | cdktf.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/db_snapshot#most_recent DataAwsDbSnapshot#most_recent}.
snapshotType	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/db_snapshot#snapshot_type DataAwsDbSnapshot#snapshot_type}.

---

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^Optional

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_snapshot#db_instance_identifier DataAwsDbSnapshot#db_instance_identifier}.

---

dbSnapshotIdentifier^Optional

public readonly dbSnapshotIdentifier: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/db_snapshot#db_snapshot_identifier DataAwsDbSnapshot#db_snapshot_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_snapshot#id DataAwsDbSnapshot#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.

---

includePublic^Optional

public readonly includePublic: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

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

---

includeShared^Optional

public readonly includeShared: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

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

---

mostRecent^Optional

public readonly mostRecent: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

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

---

snapshotType^Optional

public readonly snapshotType: string;

• Type: string

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

---