`ebsSnapshotCopy` Submodule

Constructs

EbsSnapshotCopy

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_snapshot_copy aws_ebs_snapshot_copy}.

Initializers

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

new ebsSnapshotCopy.EbsSnapshotCopy(scope: Construct, id: string, config: EbsSnapshotCopyConfig)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`string`	The scoped construct ID.
`config`	`EbsSnapshotCopyConfig`	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: EbsSnapshotCopyConfig

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".
`resetDescription`	No description.
`resetEncrypted`	No description.
`resetId`	No description.
`resetKmsKeyId`	No description.
`resetPermanentRestore`	No description.
`resetStorageTier`	No description.
`resetTags`	No description.
`resetTagsAll`	No description.
`resetTemporaryRestoreDays`	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

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

`moveTarget`^Required

Type: string

The string move target that will correspond to this resource.

`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

`hasResourceMove`

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

`importFrom`

public importFrom(id: string, provider?: TerraformProvider): void

`id`^Required

Type: string

`provider`^Optional

Type: cdktf.TerraformProvider

`interpolationForAttribute`

public interpolationForAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

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.

`id`^Required

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.

`moveTarget`^Required

Type: string

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

`index`^Optional

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

`id`^Required

Type: string

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

`resetDescription`

public resetDescription(): void

`resetEncrypted`

public resetEncrypted(): void

`resetId`

public resetId(): void

`resetKmsKeyId`

public resetKmsKeyId(): void

`resetPermanentRestore`

public resetPermanentRestore(): void

`resetStorageTier`

public resetStorageTier(): void

`resetTags`

public resetTags(): void

`resetTagsAll`

public resetTagsAll(): void

`resetTemporaryRestoreDays`

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

`isConstruct`

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

ebsSnapshotCopy.EbsSnapshotCopy.isConstruct(x: any)

Checks if x is a construct.

`x`^Required

Type: any

Any object.

`isTerraformElement`

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

ebsSnapshotCopy.EbsSnapshotCopy.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformResource`

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

ebsSnapshotCopy.EbsSnapshotCopy.isTerraformResource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

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

ebsSnapshotCopy.EbsSnapshotCopy.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

`importFromId`^Required

Type: string

The id of the existing EbsSnapshotCopy that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_snapshot_copy#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 EbsSnapshotCopy 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.
`arn`	`string`	No description.
`dataEncryptionKeyId`	`string`	No description.
`outpostArn`	`string`	No description.
`ownerAlias`	`string`	No description.
`ownerId`	`string`	No description.
`volumeId`	`string`	No description.
`volumeSize`	`number`	No description.
`descriptionInput`	`string`	No description.
`encryptedInput`	`boolean \| cdktf.IResolvable`	No description.
`idInput`	`string`	No description.
`kmsKeyIdInput`	`string`	No description.
`permanentRestoreInput`	`boolean \| cdktf.IResolvable`	No description.
`sourceRegionInput`	`string`	No description.
`sourceSnapshotIdInput`	`string`	No description.
`storageTierInput`	`string`	No description.
`tagsAllInput`	`{[ key: string ]: string}`	No description.
`tagsInput`	`{[ key: string ]: string}`	No description.
`temporaryRestoreDaysInput`	`number`	No description.
`description`	`string`	No description.
`encrypted`	`boolean \| cdktf.IResolvable`	No description.
`id`	`string`	No description.
`kmsKeyId`	`string`	No description.
`permanentRestore`	`boolean \| cdktf.IResolvable`	No description.
`sourceRegion`	`string`	No description.
`sourceSnapshotId`	`string`	No description.
`storageTier`	`string`	No description.
`tags`	`{[ key: string ]: string}`	No description.
`tagsAll`	`{[ key: string ]: string}`	No description.
`temporaryRestoreDays`	`number`	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

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

`provisioners`^Optional

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

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

`arn`^Required

public readonly arn: string;

Type: string

`dataEncryptionKeyId`^Required

public readonly dataEncryptionKeyId: string;

Type: string

`outpostArn`^Required

public readonly outpostArn: string;

Type: string

`ownerAlias`^Required

public readonly ownerAlias: string;

Type: string

`ownerId`^Required

public readonly ownerId: string;

Type: string

`volumeId`^Required

public readonly volumeId: string;

Type: string

`volumeSize`^Required

public readonly volumeSize: number;

Type: number

`descriptionInput`^Optional

public readonly descriptionInput: string;

Type: string

`encryptedInput`^Optional

public readonly encryptedInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`idInput`^Optional

public readonly idInput: string;

Type: string

`kmsKeyIdInput`^Optional

public readonly kmsKeyIdInput: string;

Type: string

`permanentRestoreInput`^Optional

public readonly permanentRestoreInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`sourceRegionInput`^Optional

public readonly sourceRegionInput: string;

Type: string

`sourceSnapshotIdInput`^Optional

public readonly sourceSnapshotIdInput: string;

Type: string

`storageTierInput`^Optional

public readonly storageTierInput: string;

Type: string

`tagsAllInput`^Optional

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

Type: {[ key: string ]: string}

`tagsInput`^Optional

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

Type: {[ key: string ]: string}

`temporaryRestoreDaysInput`^Optional

public readonly temporaryRestoreDaysInput: number;

Type: number

`description`^Required

public readonly description: string;

Type: string

`encrypted`^Required

public readonly encrypted: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`id`^Required

public readonly id: string;

Type: string

`kmsKeyId`^Required

public readonly kmsKeyId: string;

Type: string

`permanentRestore`^Required

public readonly permanentRestore: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`sourceRegion`^Required

public readonly sourceRegion: string;

Type: string

`sourceSnapshotId`^Required

public readonly sourceSnapshotId: string;

Type: string

`storageTier`^Required

public readonly storageTier: string;

Type: string

`tags`^Required

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

Type: {[ key: string ]: string}

`tagsAll`^Required

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

Type: {[ key: string ]: string}

`temporaryRestoreDays`^Required

public readonly temporaryRestoreDays: number;

Type: number

Constants

Name	Type	Description
`tfResourceType`	`string`	No description.

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

EbsSnapshotCopyConfig

Initializer

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

const ebsSnapshotCopyConfig: ebsSnapshotCopy.EbsSnapshotCopyConfig = { ... }

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.
`sourceRegion`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_snapshot_copy#source_region EbsSnapshotCopy#source_region}.
`sourceSnapshotId`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_snapshot_copy#source_snapshot_id EbsSnapshotCopy#source_snapshot_id}.
`description`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_snapshot_copy#description EbsSnapshotCopy#description}.
`encrypted`	`boolean \| cdktf.IResolvable`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_snapshot_copy#encrypted EbsSnapshotCopy#encrypted}.
`id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_snapshot_copy#id EbsSnapshotCopy#id}.
`kmsKeyId`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_snapshot_copy#kms_key_id EbsSnapshotCopy#kms_key_id}.
`permanentRestore`	`boolean \| cdktf.IResolvable`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_snapshot_copy#permanent_restore EbsSnapshotCopy#permanent_restore}.
`storageTier`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_snapshot_copy#storage_tier EbsSnapshotCopy#storage_tier}.
`tags`	`{[ key: string ]: string}`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_snapshot_copy#tags EbsSnapshotCopy#tags}.
`tagsAll`	`{[ key: string ]: string}`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_snapshot_copy#tags_all EbsSnapshotCopy#tags_all}.
`temporaryRestoreDays`	`number`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_snapshot_copy#temporary_restore_days EbsSnapshotCopy#temporary_restore_days}.

`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[]

`sourceRegion`^Required

public readonly sourceRegion: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_snapshot_copy#source_region EbsSnapshotCopy#source_region}.

`sourceSnapshotId`^Required

public readonly sourceSnapshotId: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_snapshot_copy#source_snapshot_id EbsSnapshotCopy#source_snapshot_id}.

`description`^Optional

public readonly description: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_snapshot_copy#description EbsSnapshotCopy#description}.

`encrypted`^Optional

public readonly encrypted: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_snapshot_copy#encrypted EbsSnapshotCopy#encrypted}.

`id`^Optional

public readonly id: string;

Type: string

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

`kmsKeyId`^Optional

public readonly kmsKeyId: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_snapshot_copy#kms_key_id EbsSnapshotCopy#kms_key_id}.

`permanentRestore`^Optional

public readonly permanentRestore: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_snapshot_copy#permanent_restore EbsSnapshotCopy#permanent_restore}.

`storageTier`^Optional

public readonly storageTier: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_snapshot_copy#storage_tier EbsSnapshotCopy#storage_tier}.

`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/resources/ebs_snapshot_copy#tags EbsSnapshotCopy#tags}.

`tagsAll`^Optional

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

Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_snapshot_copy#tags_all EbsSnapshotCopy#tags_all}.

`temporaryRestoreDays`^Optional

public readonly temporaryRestoreDays: number;

Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_snapshot_copy#temporary_restore_days EbsSnapshotCopy#temporary_restore_days}.

Files

ebsSnapshotCopy.md

Latest commit

History

ebsSnapshotCopy.md

File metadata and controls

ebsSnapshotCopy Submodule

Constructs