Skip to content

EphemeralEBSVolumeConfiguration

Structure Class

EphemeralEBSVolumeConfiguration dataclass

Bases: _SerdeShape

The shared Amazon EBS performance and encryption properties for a volume. These properties are common across the different volume configurations for a capacity provider.

Attributes

ebs_card_index class-attribute instance-attribute
ebs_card_index: int | None = ...

The index of the Amazon EBS card. Applies to instances with multiple Amazon EBS cards.

encrypted class-attribute instance-attribute
encrypted: bool | None = ...

Specifies whether to encrypt the volume. Encrypted volumes can be attached only to instances that support Amazon EBS encryption. If you create a volume from a snapshot, you cannot specify an encryption value.

iops class-attribute instance-attribute
iops: int | None = ...

The number of IOPS to provision. For gp3, io1, and io2 volumes, this is the number of IOPS provisioned for the volume. For gp2 volumes, this sets the baseline IOPS performance. It also controls the rate at which the volume accumulates I/O credits for bursting. Supported values: gp3, 3,000--80,000; io1, 100--64,000; io2, 100--256,000.

kms_key_id class-attribute instance-attribute
kms_key_id: str | None = ...

The identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for Amazon EBS encryption.

snapshot_id class-attribute instance-attribute
snapshot_id: str | None = ...

The ID of the snapshot.

throughput class-attribute instance-attribute
throughput: int | None = ...

The throughput to provision, in MiB/s. Valid only for gp3 volumes. Valid range: 125--2,000 MiB/s.

volume_initialization_rate class-attribute instance-attribute
volume_initialization_rate: int | None = ...

The rate at which the volume is initialized after creation, in MiB/s. Supported only for volumes created from snapshots. Valid range: 100--300 MiB/s.

volume_size class-attribute instance-attribute
volume_size: int | None = ...

The size of the volume, in GiB. You must specify either a snapshot ID or a volume size. Supported sizes: gp2, 1--16,384; gp3, 1--65,536; io1, 4--16,384; io2, 4--65,536.

volume_type class-attribute instance-attribute
volume_type: str = ...

The Amazon EBS volume type. If you do not specify a type, the default is gp3.