`ebsVolume` Submodule

Constructs

EbsVolume

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

Initializers

from cdktn_provider_aws import ebs_volume

ebsVolume.EbsVolume(
  scope: Construct,
  id: str,
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  count: typing.Union[int, float] | TerraformCount = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
  availability_zone: str,
  encrypted: bool | IResolvable = None,
  final_snapshot: bool | IResolvable = None,
  id: str = None,
  iops: typing.Union[int, float] = None,
  kms_key_id: str = None,
  multi_attach_enabled: bool | IResolvable = None,
  outpost_arn: str = None,
  region: str = None,
  size: typing.Union[int, float] = None,
  snapshot_id: str = None,
  tags: typing.Mapping[str] = None,
  tags_all: typing.Mapping[str] = None,
  throughput: typing.Union[int, float] = None,
  timeouts: EbsVolumeTimeouts = None,
  type: str = None,
  volume_initialization_rate: typing.Union[int, float] = None
)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`str`	The scoped construct ID.
`connection`	`cdktn.SSHProvisionerConnection \| cdktn.WinrmProvisionerConnection`	No description.
`count`	`typing.Union[int, float] \| cdktn.TerraformCount`	No description.
`depends_on`	`typing.List[cdktn.ITerraformDependable]`	No description.
`for_each`	`cdktn.ITerraformIterator`	No description.
`lifecycle`	`cdktn.TerraformResourceLifecycle`	No description.
`provider`	`cdktn.TerraformProvider`	No description.
`provisioners`	`typing.List[cdktn.FileProvisioner \| cdktn.LocalExecProvisioner \| cdktn.RemoteExecProvisioner]`	No description.
`availability_zone`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/ebs_volume#availability_zone EbsVolume#availability_zone}.
`encrypted`	`bool \| cdktn.IResolvable`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/ebs_volume#encrypted EbsVolume#encrypted}.
`final_snapshot`	`bool \| cdktn.IResolvable`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/ebs_volume#final_snapshot EbsVolume#final_snapshot}.
`id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/ebs_volume#id EbsVolume#id}.
`iops`	`typing.Union[int, float]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/ebs_volume#iops EbsVolume#iops}.
`kms_key_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/ebs_volume#kms_key_id EbsVolume#kms_key_id}.
`multi_attach_enabled`	`bool \| cdktn.IResolvable`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/ebs_volume#multi_attach_enabled EbsVolume#multi_attach_enabled}.
`outpost_arn`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/ebs_volume#outpost_arn EbsVolume#outpost_arn}.
`region`	`str`	Region where this resource will be managed. Defaults to the Region set in the provider configuration.
`size`	`typing.Union[int, float]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/ebs_volume#size EbsVolume#size}.
`snapshot_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/ebs_volume#snapshot_id EbsVolume#snapshot_id}.
`tags`	`typing.Mapping[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/ebs_volume#tags EbsVolume#tags}.
`tags_all`	`typing.Mapping[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/ebs_volume#tags_all EbsVolume#tags_all}.
`throughput`	`typing.Union[int, float]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/ebs_volume#throughput EbsVolume#throughput}.
`timeouts`	`EbsVolumeTimeouts`	timeouts block.
`type`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/ebs_volume#type EbsVolume#type}.
`volume_initialization_rate`	`typing.Union[int, float]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/ebs_volume#volume_initialization_rate EbsVolume#volume_initialization_rate}.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

`connection`^Optional

Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

`count`^Optional

Type: typing.Union[int, float] | cdktn.TerraformCount

`depends_on`^Optional

Type: typing.List[cdktn.ITerraformDependable]

`for_each`^Optional

Type: cdktn.ITerraformIterator

`lifecycle`^Optional

Type: cdktn.TerraformResourceLifecycle

`provider`^Optional

Type: cdktn.TerraformProvider

`provisioners`^Optional

Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]

`availability_zone`^Required

Type: str

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

`encrypted`^Optional

Type: bool | cdktn.IResolvable

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

`final_snapshot`^Optional

Type: bool | cdktn.IResolvable

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

`id`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/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

Type: typing.Union[int, float]

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

`kms_key_id`^Optional

Type: str

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

`multi_attach_enabled`^Optional

Type: bool | cdktn.IResolvable

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

`outpost_arn`^Optional

Type: str

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

`region`^Optional

Type: str

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

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

`size`^Optional

Type: typing.Union[int, float]

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

`snapshot_id`^Optional

Type: str

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

`tags`^Optional

Type: typing.Mapping[str]

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

`tags_all`^Optional

Type: typing.Mapping[str]

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

`throughput`^Optional

Type: typing.Union[int, float]

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

`timeouts`^Optional

Type: EbsVolumeTimeouts

timeouts block.

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

`type`^Optional

Type: str

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

`volume_initialization_rate`^Optional

Type: typing.Union[int, float]

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

Methods

Name	Description
`to_string`	Returns a string representation of this construct.
`with`	Applies one or more mixins to this construct.
`add_override`	No description.
`override_logical_id`	Overrides the auto-generated logical ID with a specific ID.
`reset_override_logical_id`	Resets a previously passed logical Id to use the auto-generated logical id again.
`to_hcl_terraform`	No description.
`to_metadata`	No description.
`to_terraform`	Adds this resource to the terraform JSON output.
`add_move_target`	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
`get_any_map_attribute`	No description.
`get_boolean_attribute`	No description.
`get_boolean_map_attribute`	No description.
`get_list_attribute`	No description.
`get_number_attribute`	No description.
`get_number_list_attribute`	No description.
`get_number_map_attribute`	No description.
`get_string_attribute`	No description.
`get_string_map_attribute`	No description.
`has_resource_move`	No description.
`import_from`	No description.
`interpolation_for_attribute`	No description.
`move_from_id`	Move the resource corresponding to "id" to this resource.
`move_to`	Moves this resource to the target resource given by moveTarget.
`move_to_id`	Moves this resource to the resource corresponding to "id".
`put_timeouts`	No description.
`reset_encrypted`	No description.
`reset_final_snapshot`	No description.
`reset_id`	No description.
`reset_iops`	No description.
`reset_kms_key_id`	No description.
`reset_multi_attach_enabled`	No description.
`reset_outpost_arn`	No description.
`reset_region`	No description.
`reset_size`	No description.
`reset_snapshot_id`	No description.
`reset_tags`	No description.
`reset_tags_all`	No description.
`reset_throughput`	No description.
`reset_timeouts`	No description.
`reset_type`	No description.
`reset_volume_initialization_rate`	No description.

`to_string`

def to_string() -> str

Returns a string representation of this construct.

`with`

def with(
  mixins: *IMixin
) -> IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

`mixins`^Required

Type: *constructs.IMixin

The mixins to apply.

`add_override`

def add_override(
  path: str,
  value: typing.Any
) -> None

`path`^Required

Type: str

`value`^Required

Type: typing.Any

`override_logical_id`

def override_logical_id(
  new_logical_id: str
) -> None

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

`new_logical_id`^Required

Type: str

The new logical ID to use for this stack element.

`reset_override_logical_id`

def reset_override_logical_id() -> None

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

`to_hcl_terraform`

def to_hcl_terraform() -> typing.Any

`to_metadata`

def to_metadata() -> typing.Any

`to_terraform`

def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

`add_move_target`

def add_move_target(
  move_target: str
) -> None

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

`move_target`^Required

Type: str

The string move target that will correspond to this resource.

`get_any_map_attribute`

def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]

`terraform_attribute`^Required

Type: str

`get_boolean_attribute`

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`get_boolean_map_attribute`

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

`terraform_attribute`^Required

Type: str

`get_list_attribute`

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

`terraform_attribute`^Required

Type: str

`get_number_attribute`

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

`terraform_attribute`^Required

Type: str

`get_number_list_attribute`

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_number_map_attribute`

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_string_attribute`

def get_string_attribute(
  terraform_attribute: str
) -> str

`terraform_attribute`^Required

Type: str

`get_string_map_attribute`

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

`terraform_attribute`^Required

Type: str

`has_resource_move`

def has_resource_move() -> TerraformResourceMoveByTarget | TerraformResourceMoveById

`import_from`

def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None

`id`^Required

Type: str

`provider`^Optional

Type: cdktn.TerraformProvider

`interpolation_for_attribute`

def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`move_from_id`

def move_from_id(
  id: str
) -> None

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

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

`move_to`

def move_to(
  move_target: str,
  index: str | typing.Union[int, float] = None
) -> None

Moves this resource to the target resource given by moveTarget.

`move_target`^Required

Type: str

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

`index`^Optional

Type: str | typing.Union[int, float]

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

`move_to_id`

def move_to_id(
  id: str
) -> None

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

`id`^Required

Type: str

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

`put_timeouts`

def put_timeouts(
  create: str = None,
  delete: str = None,
  update: str = None
) -> None

`create`^Optional

Type: str

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

`delete`^Optional

Type: str

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

`update`^Optional

Type: str

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

`reset_encrypted`

def reset_encrypted() -> None

`reset_final_snapshot`

def reset_final_snapshot() -> None

`reset_id`

def reset_id() -> None

`reset_iops`

def reset_iops() -> None

`reset_kms_key_id`

def reset_kms_key_id() -> None

`reset_multi_attach_enabled`

def reset_multi_attach_enabled() -> None

`reset_outpost_arn`

def reset_outpost_arn() -> None

`reset_region`

def reset_region() -> None

`reset_size`

def reset_size() -> None

`reset_snapshot_id`

def reset_snapshot_id() -> None

`reset_tags`

def reset_tags() -> None

`reset_tags_all`

def reset_tags_all() -> None

`reset_throughput`

def reset_throughput() -> None

`reset_timeouts`

def reset_timeouts() -> None

`reset_type`

def reset_type() -> None

`reset_volume_initialization_rate`

def reset_volume_initialization_rate() -> None

Static Functions

Name	Description
`is_construct`	Checks if `x` is a construct.
`is_terraform_element`	No description.
`is_terraform_resource`	No description.
`generate_config_for_import`	Generates CDKTN code for importing a EbsVolume resource upon running "cdktn plan ".

`is_construct`

from cdktn_provider_aws import ebs_volume

ebsVolume.EbsVolume.is_construct(
  x: typing.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: typing.Any

Any object.

`is_terraform_element`

from cdktn_provider_aws import ebs_volume

ebsVolume.EbsVolume.is_terraform_element(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`is_terraform_resource`

from cdktn_provider_aws import ebs_volume

ebsVolume.EbsVolume.is_terraform_resource(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`generate_config_for_import`

from cdktn_provider_aws import ebs_volume

ebsVolume.EbsVolume.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

Generates CDKTN code for importing a EbsVolume resource upon running "cdktn plan ".

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`import_to_id`^Required

Type: str

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

`import_from_id`^Required

Type: str

The id of the existing EbsVolume that should be imported.

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

`provider`^Optional

Type: cdktn.TerraformProvider

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

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`cdktf_stack`	`cdktn.TerraformStack`	No description.
`fqn`	`str`	No description.
`friendly_unique_id`	`str`	No description.
`terraform_meta_arguments`	`typing.Mapping[typing.Any]`	No description.
`terraform_resource_type`	`str`	No description.
`terraform_generator_metadata`	`cdktn.TerraformProviderGeneratorMetadata`	No description.
`connection`	`cdktn.SSHProvisionerConnection \| cdktn.WinrmProvisionerConnection`	No description.
`count`	`typing.Union[int, float] \| cdktn.TerraformCount`	No description.
`depends_on`	`typing.List[str]`	No description.
`for_each`	`cdktn.ITerraformIterator`	No description.
`lifecycle`	`cdktn.TerraformResourceLifecycle`	No description.
`provider`	`cdktn.TerraformProvider`	No description.
`provisioners`	`typing.List[cdktn.FileProvisioner \| cdktn.LocalExecProvisioner \| cdktn.RemoteExecProvisioner]`	No description.
`arn`	`str`	No description.
`create_time`	`str`	No description.
`timeouts`	`EbsVolumeTimeoutsOutputReference`	No description.
`availability_zone_input`	`str`	No description.
`encrypted_input`	`bool \| cdktn.IResolvable`	No description.
`final_snapshot_input`	`bool \| cdktn.IResolvable`	No description.
`id_input`	`str`	No description.
`iops_input`	`typing.Union[int, float]`	No description.
`kms_key_id_input`	`str`	No description.
`multi_attach_enabled_input`	`bool \| cdktn.IResolvable`	No description.
`outpost_arn_input`	`str`	No description.
`region_input`	`str`	No description.
`size_input`	`typing.Union[int, float]`	No description.
`snapshot_id_input`	`str`	No description.
`tags_all_input`	`typing.Mapping[str]`	No description.
`tags_input`	`typing.Mapping[str]`	No description.
`throughput_input`	`typing.Union[int, float]`	No description.
`timeouts_input`	`cdktn.IResolvable \| EbsVolumeTimeouts`	No description.
`type_input`	`str`	No description.
`volume_initialization_rate_input`	`typing.Union[int, float]`	No description.
`availability_zone`	`str`	No description.
`encrypted`	`bool \| cdktn.IResolvable`	No description.
`final_snapshot`	`bool \| cdktn.IResolvable`	No description.
`id`	`str`	No description.
`iops`	`typing.Union[int, float]`	No description.
`kms_key_id`	`str`	No description.
`multi_attach_enabled`	`bool \| cdktn.IResolvable`	No description.
`outpost_arn`	`str`	No description.
`region`	`str`	No description.
`size`	`typing.Union[int, float]`	No description.
`snapshot_id`	`str`	No description.
`tags`	`typing.Mapping[str]`	No description.
`tags_all`	`typing.Mapping[str]`	No description.
`throughput`	`typing.Union[int, float]`	No description.
`type`	`str`	No description.
`volume_initialization_rate`	`typing.Union[int, float]`	No description.

`node`^Required

node: Node

Type: constructs.Node

The tree node.

`cdktf_stack`^Required

cdktf_stack: TerraformStack

Type: cdktn.TerraformStack

`fqn`^Required

fqn: str

Type: str

`friendly_unique_id`^Required

friendly_unique_id: str

Type: str

`terraform_meta_arguments`^Required

terraform_meta_arguments: typing.Mapping[typing.Any]

Type: typing.Mapping[typing.Any]

`terraform_resource_type`^Required

terraform_resource_type: str

Type: str

`terraform_generator_metadata`^Optional

terraform_generator_metadata: TerraformProviderGeneratorMetadata

Type: cdktn.TerraformProviderGeneratorMetadata

`connection`^Optional

connection: SSHProvisionerConnection | WinrmProvisionerConnection

Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

`count`^Optional

count: typing.Union[int, float] | TerraformCount

Type: typing.Union[int, float] | cdktn.TerraformCount

`depends_on`^Optional

depends_on: typing.List[str]

Type: typing.List[str]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktn.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktn.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktn.TerraformProvider

`provisioners`^Optional

provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]

Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]

`arn`^Required

arn: str

Type: str

`create_time`^Required

create_time: str

Type: str

`timeouts`^Required

timeouts: EbsVolumeTimeoutsOutputReference

Type: EbsVolumeTimeoutsOutputReference

`availability_zone_input`^Optional

availability_zone_input: str

Type: str

`encrypted_input`^Optional

encrypted_input: bool | IResolvable

Type: bool | cdktn.IResolvable

`final_snapshot_input`^Optional

final_snapshot_input: bool | IResolvable

Type: bool | cdktn.IResolvable

`id_input`^Optional

id_input: str

Type: str

`iops_input`^Optional

iops_input: typing.Union[int, float]

Type: typing.Union[int, float]

`kms_key_id_input`^Optional

kms_key_id_input: str

Type: str

`multi_attach_enabled_input`^Optional

multi_attach_enabled_input: bool | IResolvable

Type: bool | cdktn.IResolvable

`outpost_arn_input`^Optional

outpost_arn_input: str

Type: str

`region_input`^Optional

region_input: str

Type: str

`size_input`^Optional

size_input: typing.Union[int, float]

Type: typing.Union[int, float]

`snapshot_id_input`^Optional

snapshot_id_input: str

Type: str

`tags_all_input`^Optional

tags_all_input: typing.Mapping[str]

Type: typing.Mapping[str]

`tags_input`^Optional

tags_input: typing.Mapping[str]

Type: typing.Mapping[str]

`throughput_input`^Optional

throughput_input: typing.Union[int, float]

Type: typing.Union[int, float]

`timeouts_input`^Optional

timeouts_input: IResolvable | EbsVolumeTimeouts

Type: cdktn.IResolvable | EbsVolumeTimeouts

`type_input`^Optional

type_input: str

Type: str

`volume_initialization_rate_input`^Optional

volume_initialization_rate_input: typing.Union[int, float]

Type: typing.Union[int, float]

`availability_zone`^Required

availability_zone: str

Type: str

`encrypted`^Required

encrypted: bool | IResolvable

Type: bool | cdktn.IResolvable

`final_snapshot`^Required

final_snapshot: bool | IResolvable

Type: bool | cdktn.IResolvable

`id`^Required

id: str

Type: str

`iops`^Required

iops: typing.Union[int, float]

Type: typing.Union[int, float]

`kms_key_id`^Required

kms_key_id: str

Type: str

`multi_attach_enabled`^Required

multi_attach_enabled: bool | IResolvable

Type: bool | cdktn.IResolvable

`outpost_arn`^Required

outpost_arn: str

Type: str

`region`^Required

region: str

Type: str

`size`^Required

size: typing.Union[int, float]

Type: typing.Union[int, float]

`snapshot_id`^Required

snapshot_id: str

Type: str

`tags`^Required

tags: typing.Mapping[str]

Type: typing.Mapping[str]

`tags_all`^Required

tags_all: typing.Mapping[str]

Type: typing.Mapping[str]

`throughput`^Required

throughput: typing.Union[int, float]

Type: typing.Union[int, float]

`type`^Required

type: str

Type: str

`volume_initialization_rate`^Required

volume_initialization_rate: typing.Union[int, float]

Type: typing.Union[int, float]

Constants

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

`tfResourceType`^Required

tfResourceType: str

Type: str

Structs

EbsVolumeConfig

Initializer

from cdktn_provider_aws import ebs_volume

ebsVolume.EbsVolumeConfig(
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  count: typing.Union[int, float] | TerraformCount = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
  availability_zone: str,
  encrypted: bool | IResolvable = None,
  final_snapshot: bool | IResolvable = None,
  id: str = None,
  iops: typing.Union[int, float] = None,
  kms_key_id: str = None,
  multi_attach_enabled: bool | IResolvable = None,
  outpost_arn: str = None,
  region: str = None,
  size: typing.Union[int, float] = None,
  snapshot_id: str = None,
  tags: typing.Mapping[str] = None,
  tags_all: typing.Mapping[str] = None,
  throughput: typing.Union[int, float] = None,
  timeouts: EbsVolumeTimeouts = None,
  type: str = None,
  volume_initialization_rate: typing.Union[int, float] = None
)

Properties

Name	Type	Description
`connection`	`cdktn.SSHProvisionerConnection \| cdktn.WinrmProvisionerConnection`	No description.
`count`	`typing.Union[int, float] \| cdktn.TerraformCount`	No description.
`depends_on`	`typing.List[cdktn.ITerraformDependable]`	No description.
`for_each`	`cdktn.ITerraformIterator`	No description.
`lifecycle`	`cdktn.TerraformResourceLifecycle`	No description.
`provider`	`cdktn.TerraformProvider`	No description.
`provisioners`	`typing.List[cdktn.FileProvisioner \| cdktn.LocalExecProvisioner \| cdktn.RemoteExecProvisioner]`	No description.
`availability_zone`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/ebs_volume#availability_zone EbsVolume#availability_zone}.
`encrypted`	`bool \| cdktn.IResolvable`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/ebs_volume#encrypted EbsVolume#encrypted}.
`final_snapshot`	`bool \| cdktn.IResolvable`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/ebs_volume#final_snapshot EbsVolume#final_snapshot}.
`id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/ebs_volume#id EbsVolume#id}.
`iops`	`typing.Union[int, float]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/ebs_volume#iops EbsVolume#iops}.
`kms_key_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/ebs_volume#kms_key_id EbsVolume#kms_key_id}.
`multi_attach_enabled`	`bool \| cdktn.IResolvable`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/ebs_volume#multi_attach_enabled EbsVolume#multi_attach_enabled}.
`outpost_arn`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/ebs_volume#outpost_arn EbsVolume#outpost_arn}.
`region`	`str`	Region where this resource will be managed. Defaults to the Region set in the provider configuration.
`size`	`typing.Union[int, float]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/ebs_volume#size EbsVolume#size}.
`snapshot_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/ebs_volume#snapshot_id EbsVolume#snapshot_id}.
`tags`	`typing.Mapping[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/ebs_volume#tags EbsVolume#tags}.
`tags_all`	`typing.Mapping[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/ebs_volume#tags_all EbsVolume#tags_all}.
`throughput`	`typing.Union[int, float]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/ebs_volume#throughput EbsVolume#throughput}.
`timeouts`	`EbsVolumeTimeouts`	timeouts block.
`type`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/ebs_volume#type EbsVolume#type}.
`volume_initialization_rate`	`typing.Union[int, float]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/ebs_volume#volume_initialization_rate EbsVolume#volume_initialization_rate}.

`connection`^Optional

connection: SSHProvisionerConnection | WinrmProvisionerConnection

Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

`count`^Optional

count: typing.Union[int, float] | TerraformCount

Type: typing.Union[int, float] | cdktn.TerraformCount

`depends_on`^Optional

depends_on: typing.List[ITerraformDependable]

Type: typing.List[cdktn.ITerraformDependable]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktn.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktn.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktn.TerraformProvider

`provisioners`^Optional

provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]

Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]

`availability_zone`^Required

availability_zone: str

Type: str

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

`encrypted`^Optional

encrypted: bool | IResolvable

Type: bool | cdktn.IResolvable

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

`final_snapshot`^Optional

final_snapshot: bool | IResolvable

Type: bool | cdktn.IResolvable

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

`id`^Optional

id: str

Type: str

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

`iops`^Optional

iops: typing.Union[int, float]

Type: typing.Union[int, float]

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

`kms_key_id`^Optional

kms_key_id: str

Type: str

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

`multi_attach_enabled`^Optional

multi_attach_enabled: bool | IResolvable

Type: bool | cdktn.IResolvable

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

`outpost_arn`^Optional

outpost_arn: str

Type: str

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

`region`^Optional

region: str

Type: str

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

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

`size`^Optional

size: typing.Union[int, float]

Type: typing.Union[int, float]

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

`snapshot_id`^Optional

snapshot_id: str

Type: str

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

`tags`^Optional

tags: typing.Mapping[str]

Type: typing.Mapping[str]

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

`tags_all`^Optional

tags_all: typing.Mapping[str]

Type: typing.Mapping[str]

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

`throughput`^Optional

throughput: typing.Union[int, float]

Type: typing.Union[int, float]

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

`timeouts`^Optional

timeouts: EbsVolumeTimeouts

Type: EbsVolumeTimeouts

timeouts block.

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

`type`^Optional

type: str

Type: str

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

`volume_initialization_rate`^Optional

volume_initialization_rate: typing.Union[int, float]

Type: typing.Union[int, float]

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

EbsVolumeTimeouts

Initializer

from cdktn_provider_aws import ebs_volume

ebsVolume.EbsVolumeTimeouts(
  create: str = None,
  delete: str = None,
  update: str = None
)

Properties

Name	Type	Description
`create`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/ebs_volume#create EbsVolume#create}.
`delete`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/ebs_volume#delete EbsVolume#delete}.
`update`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/ebs_volume#update EbsVolume#update}.

`create`^Optional

create: str

Type: str

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

`delete`^Optional

delete: str

Type: str

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

`update`^Optional

update: str

Type: str

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

Classes

EbsVolumeTimeoutsOutputReference

Initializers

from cdktn_provider_aws import ebs_volume

ebsVolume.EbsVolumeTimeoutsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)

Name	Type	Description
`terraform_resource`	`cdktn.IInterpolatingParent`	The parent resource.
`terraform_attribute`	`str`	The attribute on the parent resource this class is referencing.

`terraform_resource`^Required

Type: cdktn.IInterpolatingParent

The parent resource.

`terraform_attribute`^Required

Type: str

The attribute on the parent resource this class is referencing.

Methods

Name	Description
`compute_fqn`	No description.
`get_any_map_attribute`	No description.
`get_boolean_attribute`	No description.
`get_boolean_map_attribute`	No description.
`get_list_attribute`	No description.
`get_number_attribute`	No description.
`get_number_list_attribute`	No description.
`get_number_map_attribute`	No description.
`get_string_attribute`	No description.
`get_string_map_attribute`	No description.
`interpolation_for_attribute`	No description.
`resolve`	Produce the Token's value at resolution time.
`to_string`	Return a string representation of this resolvable object.
`reset_create`	No description.
`reset_delete`	No description.
`reset_update`	No description.

`compute_fqn`

def compute_fqn() -> str

`get_any_map_attribute`

def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]

`terraform_attribute`^Required

Type: str

`get_boolean_attribute`

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`get_boolean_map_attribute`

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

`terraform_attribute`^Required

Type: str

`get_list_attribute`

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

`terraform_attribute`^Required

Type: str

`get_number_attribute`

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

`terraform_attribute`^Required

Type: str

`get_number_list_attribute`

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_number_map_attribute`

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_string_attribute`

def get_string_attribute(
  terraform_attribute: str
) -> str

`terraform_attribute`^Required

Type: str

`get_string_map_attribute`

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

`terraform_attribute`^Required

Type: str

`interpolation_for_attribute`

def interpolation_for_attribute(
  property: str
) -> IResolvable

`property`^Required

Type: str

`resolve`

def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktn.IResolveContext

`to_string`

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

`reset_create`

def reset_create() -> None

`reset_delete`

def reset_delete() -> None

`reset_update`

def reset_update() -> None

Properties

Name	Type	Description
`creation_stack`	`typing.List[str]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`str`	No description.
`create_input`	`str`	No description.
`delete_input`	`str`	No description.
`update_input`	`str`	No description.
`create`	`str`	No description.
`delete`	`str`	No description.
`update`	`str`	No description.
`internal_value`	`cdktn.IResolvable \| EbsVolumeTimeouts`	No description.

`creation_stack`^Required

creation_stack: typing.List[str]

Type: typing.List[str]

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.

`fqn`^Required

fqn: str

Type: str

`create_input`^Optional

create_input: str

Type: str

`delete_input`^Optional

delete_input: str

Type: str

`update_input`^Optional

update_input: str

Type: str

`create`^Required

create: str

Type: str

`delete`^Required

delete: str

Type: str

`update`^Required

update: str

Type: str

`internal_value`^Optional

internal_value: IResolvable | EbsVolumeTimeouts

Type: cdktn.IResolvable | EbsVolumeTimeouts

FilesExpand file tree

ebsVolume.python.md

Latest commit

History

ebsVolume.python.md

File metadata and controls

ebsVolume Submodule

Constructs

EbsVolume

Initializers

scopeRequired

idRequired

connectionOptional

countOptional

depends_onOptional

for_eachOptional

lifecycleOptional

providerOptional

provisionersOptional

availability_zoneRequired

encryptedOptional

final_snapshotOptional

idOptional

iopsOptional

kms_key_idOptional

multi_attach_enabledOptional

outpost_arnOptional

regionOptional

sizeOptional

snapshot_idOptional

tagsOptional

tags_allOptional

throughputOptional

timeoutsOptional

typeOptional

volume_initialization_rateOptional

Methods

to_string

with

mixinsRequired

add_override

pathRequired

valueRequired

override_logical_id

new_logical_idRequired

reset_override_logical_id

to_hcl_terraform

to_metadata

to_terraform

add_move_target

move_targetRequired

get_any_map_attribute

terraform_attributeRequired

get_boolean_attribute

terraform_attributeRequired

get_boolean_map_attribute

terraform_attributeRequired

get_list_attribute

terraform_attributeRequired

get_number_attribute

terraform_attributeRequired

get_number_list_attribute

terraform_attributeRequired

get_number_map_attribute

terraform_attributeRequired

get_string_attribute

terraform_attributeRequired

get_string_map_attribute

terraform_attributeRequired

has_resource_move

import_from

idRequired

providerOptional

interpolation_for_attribute

terraform_attributeRequired

move_from_id

idRequired

move_to

move_targetRequired

indexOptional

`ebsVolume` Submodule

`scope`^Required

`id`^Required

`connection`^Optional

`count`^Optional

`depends_on`^Optional

`for_each`^Optional

`lifecycle`^Optional

`provider`^Optional

`provisioners`^Optional

`availability_zone`^Required

`encrypted`^Optional

`final_snapshot`^Optional

`id`^Optional

`iops`^Optional

`kms_key_id`^Optional

`multi_attach_enabled`^Optional

`outpost_arn`^Optional

`region`^Optional

`size`^Optional

`snapshot_id`^Optional

`tags`^Optional

`tags_all`^Optional

`throughput`^Optional

`timeouts`^Optional

`type`^Optional

`volume_initialization_rate`^Optional

`to_string`

`with`

`mixins`^Required

`add_override`

`path`^Required

`value`^Required

`override_logical_id`

`new_logical_id`^Required

`reset_override_logical_id`

`to_hcl_terraform`

`to_metadata`

`to_terraform`

`add_move_target`

`move_target`^Required

`get_any_map_attribute`

`terraform_attribute`^Required

`get_boolean_attribute`

`terraform_attribute`^Required

`get_boolean_map_attribute`

`terraform_attribute`^Required

`get_list_attribute`

`terraform_attribute`^Required

`get_number_attribute`

`terraform_attribute`^Required

`get_number_list_attribute`

`terraform_attribute`^Required

`get_number_map_attribute`

`terraform_attribute`^Required

`get_string_attribute`

`terraform_attribute`^Required

`get_string_map_attribute`

`terraform_attribute`^Required

`has_resource_move`

`import_from`

`id`^Required

`provider`^Optional

`interpolation_for_attribute`

`terraform_attribute`^Required

`move_from_id`

`id`^Required

`move_to`

`move_target`^Required

`index`^Optional

`move_to_id`

`id`^Required

`put_timeouts`

`create`^Optional

`delete`^Optional

`update`^Optional

`reset_encrypted`

`reset_final_snapshot`

`reset_id`

`reset_iops`