ebsVolume.md

ebsVolume Submodule

Constructs

EbsVolume

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

Initializers

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

new ebsVolume.EbsVolume(scope: Construct, id: string, config: EbsVolumeConfig)

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

---

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".
resetEncrypted	No description.
resetId	No description.
resetIops	No description.
resetKmsKeyId	No description.
resetMultiAttachEnabled	No description.
resetOutpostArn	No description.
resetSize	No description.
resetSnapshotId	No description.
resetTags	No description.
resetTagsAll	No description.
resetThroughput	No description.
resetType	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".

---

resetEncrypted

public resetEncrypted(): void

resetId

public resetId(): void

resetIops

public resetIops(): void

resetKmsKeyId

public resetKmsKeyId(): void

resetMultiAttachEnabled

public resetMultiAttachEnabled(): void

resetOutpostArn

public resetOutpostArn(): void

resetSize

public resetSize(): void

resetSnapshotId

public resetSnapshotId(): void

resetTags

public resetTags(): void

resetTagsAll

public resetTagsAll(): void

resetThroughput

public resetThroughput(): void

resetType

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

---

isConstruct

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

ebsVolume.EbsVolume.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

isTerraformElement

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

ebsVolume.EbsVolume.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

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

ebsVolume.EbsVolume.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

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

ebsVolume.EbsVolume.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

---

importFromId^Required

• Type: string

The id of the existing EbsVolume that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_volume#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 EbsVolume 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.
availabilityZoneInput	string	No description.
encryptedInput	boolean | cdktf.IResolvable	No description.
idInput	string	No description.
iopsInput	number	No description.
kmsKeyIdInput	string	No description.
multiAttachEnabledInput	boolean | cdktf.IResolvable	No description.
outpostArnInput	string	No description.
sizeInput	number	No description.
snapshotIdInput	string	No description.
tagsAllInput	{[ key: string ]: string}	No description.
tagsInput	{[ key: string ]: string}	No description.
throughputInput	number	No description.
typeInput	string	No description.
availabilityZone	string	No description.
encrypted	boolean | cdktf.IResolvable	No description.
id	string	No description.
iops	number	No description.
kmsKeyId	string	No description.
multiAttachEnabled	boolean | cdktf.IResolvable	No description.
outpostArn	string	No description.
size	number	No description.
snapshotId	string	No description.
tags	{[ key: string ]: string}	No description.
tagsAll	{[ key: string ]: string}	No description.
throughput	number	No description.
type	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

---

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

---

availabilityZoneInput^Optional

public readonly availabilityZoneInput: string;

• Type: string

---

encryptedInput^Optional

public readonly encryptedInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

iopsInput^Optional

public readonly iopsInput: number;

• Type: number

---

kmsKeyIdInput^Optional

public readonly kmsKeyIdInput: string;

• Type: string

---

multiAttachEnabledInput^Optional

public readonly multiAttachEnabledInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

outpostArnInput^Optional

public readonly outpostArnInput: string;

• Type: string

---

sizeInput^Optional

public readonly sizeInput: number;

• Type: number

---

snapshotIdInput^Optional

public readonly snapshotIdInput: 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}

---

throughputInput^Optional

public readonly throughputInput: number;

• Type: number

---

typeInput^Optional

public readonly typeInput: string;

• Type: string

---

availabilityZone^Required

public readonly availabilityZone: string;

• Type: string

---

encrypted^Required

public readonly encrypted: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

id^Required

public readonly id: string;

• Type: string

---

iops^Required

public readonly iops: number;

• Type: number

---

kmsKeyId^Required

public readonly kmsKeyId: string;

• Type: string

---

multiAttachEnabled^Required

public readonly multiAttachEnabled: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

outpostArn^Required

public readonly outpostArn: string;

• Type: string

---

size^Required

public readonly size: number;

• Type: number

---

snapshotId^Required

public readonly snapshotId: 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}

---

throughput^Required

public readonly throughput: number;

• Type: number

---

type^Required

public readonly type: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

EbsVolumeConfig

Initializer

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

const ebsVolumeConfig: ebsVolume.EbsVolumeConfig = { ... }

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.
availabilityZone	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_volume#availability_zone EbsVolume#availability_zone}.
encrypted	boolean | cdktf.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_volume#encrypted EbsVolume#encrypted}.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_volume#id EbsVolume#id}.
iops	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_volume#iops EbsVolume#iops}.
kmsKeyId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_volume#kms_key_id EbsVolume#kms_key_id}.
multiAttachEnabled	boolean | cdktf.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_volume#multi_attach_enabled EbsVolume#multi_attach_enabled}.
outpostArn	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_volume#outpost_arn EbsVolume#outpost_arn}.
size	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_volume#size EbsVolume#size}.
snapshotId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_volume#snapshot_id EbsVolume#snapshot_id}.
tags	{[ key: string ]: string}	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_volume#tags EbsVolume#tags}.
tagsAll	{[ key: string ]: string}	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_volume#tags_all EbsVolume#tags_all}.
throughput	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_volume#throughput EbsVolume#throughput}.
type	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_volume#type EbsVolume#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[]

---

availabilityZone^Required

public readonly availabilityZone: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_volume#availability_zone EbsVolume#availability_zone}.

---

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_volume#encrypted EbsVolume#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_volume#id EbsVolume#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.

---

iops^Optional

public readonly iops: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_volume#iops EbsVolume#iops}.

---

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_volume#kms_key_id EbsVolume#kms_key_id}.

---

multiAttachEnabled^Optional

public readonly multiAttachEnabled: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_volume#multi_attach_enabled EbsVolume#multi_attach_enabled}.

---

outpostArn^Optional

public readonly outpostArn: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_volume#outpost_arn EbsVolume#outpost_arn}.

---

size^Optional

public readonly size: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_volume#size EbsVolume#size}.

---

snapshotId^Optional

public readonly snapshotId: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_volume#snapshot_id EbsVolume#snapshot_id}.

---

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_volume#tags EbsVolume#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_volume#tags_all EbsVolume#tags_all}.

---

throughput^Optional

public readonly throughput: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_volume#throughput EbsVolume#throughput}.

---

type^Optional

public readonly type: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ebs_volume#type EbsVolume#type}.

---