VolumeSummary

The summary of a persistent volume.

availabilityZoneId

The Availability Zone ID of the volume.

Type: String

Required: Yes

farmId

The farm ID of the farm that contains the fleet.

Type: String

Pattern: farm-[0-9a-f]{32}

Required: Yes

fleetId

The fleet ID of the fleet that contains the volume.

Type: String

Pattern: fleet-[0-9a-f]{32}

Required: Yes

sizeGiB

The volume size in GiB.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 65536.

Required: Yes

state

The state of the volume.

Type: String

Valid Values: PENDING_CREATION | PENDING_ATTACHMENT | IN_USE | AVAILABLE | PENDING_DELETION

Required: Yes

volumeId

The volume ID.

Type: String

Pattern: volume-[0-9a-f]{32}

Required: Yes

attachedWorkerId

The worker ID of the worker the volume is attached to.

Type: String

Pattern: worker-[0-9a-f]{32}

Required: No

Contents