Skip to main content
Version: Next

general_purpose_volume

Table to manage AWS general purpose Volume entities. Amazon Elastic Block Store (Amazon EBS) provides block level storage volumes for use with EC2 instances. EBS volumes behave like raw, unformatted block devices.

See

https://aws.amazon.com/ebs/general-purpose/

Columns​

• availability_zone: availability_zone

Reference to the availability zone for the volume

• Optional instance_block_device_mappings: instance_block_device_mapping[]

Block device mappings for the instance

• Optional iops: number

The number of I/O operations per second (IOPS)

See

https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ec2/interfaces/createvolumerequest.html#iops

• Optional is_root_device: boolean

If set to true it will not be created and used only for defining initial EBS on instance creation

See

https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html

• region: string

Region for the volume

• size: number

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size.

• Optional snapshot_id: string

The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.

• Optional state: volume_state

Current state of the volume

• Optional tags: Object

Complex type to provide identifier tags for the volume

See

https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ec2/interfaces/createvolumecommandinput.html#tagspecifications

Type definition​

▪ [key: string]: string

• Optional throughput: number

The throughput to provision for a volume, with a maximum of 1,000 MiB/s. Only valid for gp3 volumes

• Optional volume_id: string

AWS generated ID for the volume

• volume_type: general_purpose_volume_type

Type of volume