Skip to content

EbsVolumeConfigurationDict

Dictionary Type

EbsVolumeConfigurationDict

Bases: TypedDict

Dictionary form of EbsVolumeConfiguration.

Attributes

encrypted instance-attribute
encrypted: bool | None

Specifies whether to encrypt the volume. If true, the service encrypts the volume with the KMS key that you specify in kmsKeyId, or the default KMS key for Amazon EBS if you do not specify one. The default is true.

iops instance-attribute
iops: int | None

The number of IOPS to provision. Valid only for gp3, io1, and io2 volumes.

kms_key_id instance-attribute
kms_key_id: str | None

The identifier of the KMS key to use for encryption.

name instance-attribute
name: Required[str]

The logical name of the volume. Use this name to reference the volume when you mount it into an agent runtime.

size_gi_b instance-attribute
size_gi_b: Required[int]

The size of the volume, in GiB.

snapshot_id instance-attribute
snapshot_id: str | None

An optional Amazon EBS snapshot ID. If provided, the volume is initialized from this snapshot the first time it is created. On subsequent restarts, the existing volume is used and the snapshot is ignored.

throughput instance-attribute
throughput: int | None

The throughput, in MiB/s. Valid only for gp3 volumes.

volume_type instance-attribute
volume_type: str | None

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