Skip to content

Latest commit

 

History

History
1762 lines (1096 loc) · 73.3 KB

dbSnapshotCopy.typescript.md

File metadata and controls

1762 lines (1096 loc) · 73.3 KB

dbSnapshotCopy Submodule

Constructs

DbSnapshotCopy

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/db_snapshot_copy aws_db_snapshot_copy}.

Initializers

import { dbSnapshotCopy } from '@cdktf/provider-aws'

new dbSnapshotCopy.DbSnapshotCopy(scope: Construct, id: string, config: DbSnapshotCopyConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config DbSnapshotCopyConfig No description.

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope


configRequired

Methods

Name Description
toString Returns a string representation of this construct.
addOverride No description.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform No description.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
addMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
hasResourceMove No description.
importFrom No description.
interpolationForAttribute No description.
moveFromId Move the resource corresponding to "id" to this resource.
moveTo Moves this resource to the target resource given by moveTarget.
moveToId Moves this resource to the resource corresponding to "id".
putTimeouts No description.
resetCopyTags No description.
resetDestinationRegion No description.
resetId No description.
resetKmsKeyId No description.
resetOptionGroupName No description.
resetPresignedUrl No description.
resetSharedAccounts No description.
resetTags No description.
resetTagsAll No description.
resetTargetCustomAvailabilityZone No description.
resetTimeouts No description.

toString
public toString(): string

Returns a string representation of this construct.

addOverride
public addOverride(path: string, value: any): void
pathRequired
  • Type: string

valueRequired
  • Type: any

overrideLogicalId
public overrideLogicalId(newLogicalId: string): void

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

newLogicalIdRequired
  • 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
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget
public addMoveTarget(moveTarget: string): void

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

The string move target that will correspond to this resource.


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

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

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

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

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

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

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

hasResourceMove
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom
public importFrom(id: string, provider?: TerraformProvider): void
idRequired
  • Type: string

providerOptional
  • Type: cdktf.TerraformProvider

interpolationForAttribute
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

moveFromId
public moveFromId(id: string): void

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

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


moveTo
public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: string

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


indexOptional
  • Type: string | number

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


moveToId
public moveToId(id: string): void

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

idRequired
  • Type: string

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


putTimeouts
public putTimeouts(value: DbSnapshotCopyTimeouts): void
valueRequired

resetCopyTags
public resetCopyTags(): void
resetDestinationRegion
public resetDestinationRegion(): void
resetId
public resetId(): void
resetKmsKeyId
public resetKmsKeyId(): void
resetOptionGroupName
public resetOptionGroupName(): void
resetPresignedUrl
public resetPresignedUrl(): void
resetSharedAccounts
public resetSharedAccounts(): void
resetTags
public resetTags(): void
resetTagsAll
public resetTagsAll(): void
resetTargetCustomAvailabilityZone
public resetTargetCustomAvailabilityZone(): void
resetTimeouts
public resetTimeouts(): void

Static Functions

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

isConstruct
import { dbSnapshotCopy } from '@cdktf/provider-aws'

dbSnapshotCopy.DbSnapshotCopy.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.

xRequired
  • Type: any

Any object.


isTerraformElement
import { dbSnapshotCopy } from '@cdktf/provider-aws'

dbSnapshotCopy.DbSnapshotCopy.isTerraformElement(x: any)
xRequired
  • Type: any

isTerraformResource
import { dbSnapshotCopy } from '@cdktf/provider-aws'

dbSnapshotCopy.DbSnapshotCopy.isTerraformResource(x: any)
xRequired
  • Type: any

generateConfigForImport
import { dbSnapshotCopy } from '@cdktf/provider-aws'

dbSnapshotCopy.DbSnapshotCopy.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


importToIdRequired
  • Type: string

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


importFromIdRequired
  • Type: string

The id of the existing DbSnapshotCopy that should be imported.

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


providerOptional
  • Type: cdktf.TerraformProvider

? Optional instance of the provider where the DbSnapshotCopy 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.
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection 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.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] 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.
licenseModel string No description.
port number No description.
snapshotType string No description.
sourceRegion string No description.
storageType string No description.
timeouts DbSnapshotCopyTimeoutsOutputReference No description.
vpcId string No description.
copyTagsInput boolean | cdktf.IResolvable No description.
destinationRegionInput string No description.
idInput string No description.
kmsKeyIdInput string No description.
optionGroupNameInput string No description.
presignedUrlInput string No description.
sharedAccountsInput string[] No description.
sourceDbSnapshotIdentifierInput string No description.
tagsAllInput {[ key: string ]: string} No description.
tagsInput {[ key: string ]: string} No description.
targetCustomAvailabilityZoneInput string No description.
targetDbSnapshotIdentifierInput string No description.
timeoutsInput cdktf.IResolvable | DbSnapshotCopyTimeouts No description.
copyTags boolean | cdktf.IResolvable No description.
destinationRegion string No description.
id string No description.
kmsKeyId string No description.
optionGroupName string No description.
presignedUrl string No description.
sharedAccounts string[] No description.
sourceDbSnapshotIdentifier string No description.
tags {[ key: string ]: string} No description.
tagsAll {[ key: string ]: string} No description.
targetCustomAvailabilityZone string No description.
targetDbSnapshotIdentifier string No description.

nodeRequired
public readonly node: Node;
  • Type: constructs.Node

The tree node.


cdktfStackRequired
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack

fqnRequired
public readonly fqn: string;
  • Type: string

friendlyUniqueIdRequired
public readonly friendlyUniqueId: string;
  • Type: string

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

terraformResourceTypeRequired
public readonly terraformResourceType: string;
  • Type: string

terraformGeneratorMetadataOptional
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: string[];
  • Type: string[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

provisionersOptional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

allocatedStorageRequired
public readonly allocatedStorage: number;
  • Type: number

availabilityZoneRequired
public readonly availabilityZone: string;
  • Type: string

dbSnapshotArnRequired
public readonly dbSnapshotArn: string;
  • Type: string

encryptedRequired
public readonly encrypted: IResolvable;
  • Type: cdktf.IResolvable

engineRequired
public readonly engine: string;
  • Type: string

engineVersionRequired
public readonly engineVersion: string;
  • Type: string

iopsRequired
public readonly iops: number;
  • Type: number

licenseModelRequired
public readonly licenseModel: string;
  • Type: string

portRequired
public readonly port: number;
  • Type: number

snapshotTypeRequired
public readonly snapshotType: string;
  • Type: string

sourceRegionRequired
public readonly sourceRegion: string;
  • Type: string

storageTypeRequired
public readonly storageType: string;
  • Type: string

timeoutsRequired
public readonly timeouts: DbSnapshotCopyTimeoutsOutputReference;

vpcIdRequired
public readonly vpcId: string;
  • Type: string

copyTagsInputOptional
public readonly copyTagsInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

destinationRegionInputOptional
public readonly destinationRegionInput: string;
  • Type: string

idInputOptional
public readonly idInput: string;
  • Type: string

kmsKeyIdInputOptional
public readonly kmsKeyIdInput: string;
  • Type: string

optionGroupNameInputOptional
public readonly optionGroupNameInput: string;
  • Type: string

presignedUrlInputOptional
public readonly presignedUrlInput: string;
  • Type: string

sharedAccountsInputOptional
public readonly sharedAccountsInput: string[];
  • Type: string[]

sourceDbSnapshotIdentifierInputOptional
public readonly sourceDbSnapshotIdentifierInput: string;
  • Type: string

tagsAllInputOptional
public readonly tagsAllInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

tagsInputOptional
public readonly tagsInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

targetCustomAvailabilityZoneInputOptional
public readonly targetCustomAvailabilityZoneInput: string;
  • Type: string

targetDbSnapshotIdentifierInputOptional
public readonly targetDbSnapshotIdentifierInput: string;
  • Type: string

timeoutsInputOptional
public readonly timeoutsInput: IResolvable | DbSnapshotCopyTimeouts;

copyTagsRequired
public readonly copyTags: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

destinationRegionRequired
public readonly destinationRegion: string;
  • Type: string

idRequired
public readonly id: string;
  • Type: string

kmsKeyIdRequired
public readonly kmsKeyId: string;
  • Type: string

optionGroupNameRequired
public readonly optionGroupName: string;
  • Type: string

presignedUrlRequired
public readonly presignedUrl: string;
  • Type: string

sharedAccountsRequired
public readonly sharedAccounts: string[];
  • Type: string[]

sourceDbSnapshotIdentifierRequired
public readonly sourceDbSnapshotIdentifier: string;
  • Type: string

tagsRequired
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

tagsAllRequired
public readonly tagsAll: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

targetCustomAvailabilityZoneRequired
public readonly targetCustomAvailabilityZone: string;
  • Type: string

targetDbSnapshotIdentifierRequired
public readonly targetDbSnapshotIdentifier: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

DbSnapshotCopyConfig

Initializer

import { dbSnapshotCopy } from '@cdktf/provider-aws'

const dbSnapshotCopyConfig: dbSnapshotCopy.DbSnapshotCopyConfig = { ... }

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.
sourceDbSnapshotIdentifier string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/db_snapshot_copy#source_db_snapshot_identifier DbSnapshotCopy#source_db_snapshot_identifier}.
targetDbSnapshotIdentifier string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/db_snapshot_copy#target_db_snapshot_identifier DbSnapshotCopy#target_db_snapshot_identifier}.
copyTags boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/db_snapshot_copy#copy_tags DbSnapshotCopy#copy_tags}.
destinationRegion string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/db_snapshot_copy#destination_region DbSnapshotCopy#destination_region}.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/db_snapshot_copy#id DbSnapshotCopy#id}.
kmsKeyId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/db_snapshot_copy#kms_key_id DbSnapshotCopy#kms_key_id}.
optionGroupName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/db_snapshot_copy#option_group_name DbSnapshotCopy#option_group_name}.
presignedUrl string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/db_snapshot_copy#presigned_url DbSnapshotCopy#presigned_url}.
sharedAccounts string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/db_snapshot_copy#shared_accounts DbSnapshotCopy#shared_accounts}.
tags {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/db_snapshot_copy#tags DbSnapshotCopy#tags}.
tagsAll {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/db_snapshot_copy#tags_all DbSnapshotCopy#tags_all}.
targetCustomAvailabilityZone string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/db_snapshot_copy#target_custom_availability_zone DbSnapshotCopy#target_custom_availability_zone}.
timeouts DbSnapshotCopyTimeouts timeouts block.

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

provisionersOptional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

sourceDbSnapshotIdentifierRequired
public readonly sourceDbSnapshotIdentifier: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/db_snapshot_copy#source_db_snapshot_identifier DbSnapshotCopy#source_db_snapshot_identifier}.


targetDbSnapshotIdentifierRequired
public readonly targetDbSnapshotIdentifier: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/db_snapshot_copy#target_db_snapshot_identifier DbSnapshotCopy#target_db_snapshot_identifier}.


copyTagsOptional
public readonly copyTags: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/db_snapshot_copy#copy_tags DbSnapshotCopy#copy_tags}.


destinationRegionOptional
public readonly destinationRegion: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/db_snapshot_copy#destination_region DbSnapshotCopy#destination_region}.


idOptional
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/db_snapshot_copy#id DbSnapshotCopy#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.


kmsKeyIdOptional
public readonly kmsKeyId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/db_snapshot_copy#kms_key_id DbSnapshotCopy#kms_key_id}.


optionGroupNameOptional
public readonly optionGroupName: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/db_snapshot_copy#option_group_name DbSnapshotCopy#option_group_name}.


presignedUrlOptional
public readonly presignedUrl: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/db_snapshot_copy#presigned_url DbSnapshotCopy#presigned_url}.


sharedAccountsOptional
public readonly sharedAccounts: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/db_snapshot_copy#shared_accounts DbSnapshotCopy#shared_accounts}.


tagsOptional
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/db_snapshot_copy#tags DbSnapshotCopy#tags}.


tagsAllOptional
public readonly tagsAll: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/db_snapshot_copy#tags_all DbSnapshotCopy#tags_all}.


targetCustomAvailabilityZoneOptional
public readonly targetCustomAvailabilityZone: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/db_snapshot_copy#target_custom_availability_zone DbSnapshotCopy#target_custom_availability_zone}.


timeoutsOptional
public readonly timeouts: DbSnapshotCopyTimeouts;

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/db_snapshot_copy#timeouts DbSnapshotCopy#timeouts}


DbSnapshotCopyTimeouts

Initializer

import { dbSnapshotCopy } from '@cdktf/provider-aws'

const dbSnapshotCopyTimeouts: dbSnapshotCopy.DbSnapshotCopyTimeouts = { ... }

Properties

Name Type Description
create string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/db_snapshot_copy#create DbSnapshotCopy#create}.

createOptional
public readonly create: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/db_snapshot_copy#create DbSnapshotCopy#create}.


Classes

DbSnapshotCopyTimeoutsOutputReference

Initializers

import { dbSnapshotCopy } from '@cdktf/provider-aws'

new dbSnapshotCopy.DbSnapshotCopyTimeoutsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetCreate No description.

computeFqn
public computeFqn(): string
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

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

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

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

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

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

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetCreate
public resetCreate(): void

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
createInput string No description.
create string No description.
internalValue cdktf.IResolvable | DbSnapshotCopyTimeouts No description.

creationStackRequired
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


fqnRequired
public readonly fqn: string;
  • Type: string

createInputOptional
public readonly createInput: string;
  • Type: string

createRequired
public readonly create: string;
  • Type: string

internalValueOptional
public readonly internalValue: IResolvable | DbSnapshotCopyTimeouts;