Skip to content

Bedrock AgentCore Control  >  Structures  >  EbsVolumeConfiguration

EbsVolumeConfiguration

Structure Class

EbsVolumeConfiguration dataclass

The configuration for an Amazon EBS-backed persistent volume. The service creates persistent volumes when a session first launches, and the volumes survive instance termination. The volumes persist until you delete the session.

Attributes

encrypted class-attribute instance-attribute
encrypted: bool | None = 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 class-attribute instance-attribute
iops: int | None = None

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

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

The identifier of the KMS key to use for encryption.

name instance-attribute
name: 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: int

The size of the volume, in GiB.

snapshot_id class-attribute instance-attribute
snapshot_id: str | None = 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 class-attribute instance-attribute
throughput: int | None = None

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

volume_type class-attribute instance-attribute
volume_type: EbsVolumeType = EbsVolumeType('gp3')

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