volume

Gets an individual volume resource

Overview

Name	volume
Type	Resource
Description	volume
Id	awscc.ec2.volume

Fields

Name	Datatype	Description
multi_attach_enabled	boolean	Indicates whether Amazon EBS Multi-Attach is enabled.<br/> CFNlong does not currently support updating a single-attach volume to be multi-attach enabled, updating a multi-attach enabled volume to be single-attach, or updating the size or number of I/O operations per second (IOPS) of a multi-attach enabled volume.
kms_key_id	string	The identifier of the kms-key-long to use for Amazon EBS encryption. If ``KmsKeyId`` is specified, the encrypted state must be ``true``.<br/> If you omit this property and your account is enabled for encryption by default, or *Encrypted* is set to ``true``, then the volume is encrypted using the default key specified for your account. If your account does not have a default key, then the volume is encrypted using the aws-managed-key.<br/> Alternatively, if you want to specify a different key, you can specify one of the following:<br/> + Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.<br/> + Key alias. Specify the alias for the key, prefixed with ``alias/``. For example, for a key with the alias ``my_cmk``, use ``alias/my_cmk``. Or to specify the aws-managed-key, use ``alias/aws/ebs``.<br/> + Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.<br/> + Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
encrypted	boolean	Indicates whether the volume should be encrypted. The effect of setting the encryption state to ``true`` depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see [Encryption by default](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default) in the *Amazon Elastic Compute Cloud User Guide*.<br/> Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see [Supported instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances).
size	integer	The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.<br/> The following are the supported volumes sizes for each volume type:<br/> + ``gp2`` and ``gp3``: 1 - 16,384 GiB<br/> + ``io1``: 4 - 16,384 GiB<br/> + ``io2``: 4 - 65,536 GiB<br/> + ``st1`` and ``sc1``: 125 - 16,384 GiB<br/> + ``standard``: 1 - 1024 GiB
auto_enable_io	boolean	Indicates whether the volume is auto-enabled for I/O operations. By default, Amazon EBS disables I/O to the volume from attached EC2 instances when it determines that a volume's data is potentially inconsistent. If the consistency of the volume is not a concern, and you prefer that the volume be made available immediately if it's impaired, you can configure the volume to automatically enable I/O.
outpost_arn	string	The Amazon Resource Name (ARN) of the Outpost.
availability_zone	string	The ID of the Availability Zone in which to create the volume. For example, ``us-east-1a``.
throughput	integer	The throughput to provision for a volume, with a maximum of 1,000 MiB/s.<br/> This parameter is valid only for ``gp3`` volumes. The default value is 125.<br/> Valid Range: Minimum value of 125. Maximum value of 1000.
iops	integer	The number of I/O operations per second (IOPS). For ``gp3``, ``io1``, and ``io2`` volumes, this represents the number of IOPS that are provisioned for the volume. For ``gp2`` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.<br/> The following are the supported values for each volume type:<br/> + ``gp3``: 3,000 - 16,000 IOPS<br/> + ``io1``: 100 - 64,000 IOPS<br/> + ``io2``: 100 - 256,000 IOPS<br/> <br/> For ``io2`` volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances). On other instances, you can achieve performance up to 32,000 IOPS.<br/> This parameter is required for ``io1`` and ``io2`` volumes. The default for ``gp3`` volumes is 3,000 IOPS. This parameter is not supported for ``gp2``, ``st1``, ``sc1``, or ``standard`` volumes.
snapshot_id	string	The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
volume_type	string	The volume type. This parameter can be one of the following values:<br/> + General Purpose SSD: ``gp2`` | ``gp3`` <br/> + Provisioned IOPS SSD: ``io1`` | ``io2`` <br/> + Throughput Optimized HDD: ``st1`` <br/> + Cold HDD: ``sc1`` <br/> + Magnetic: ``standard`` <br/> <br/> For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon Elastic Compute Cloud User Guide*.<br/> Default: ``gp2``
volume_id	string
tags	array	The tags to apply to the volume during creation.
region	string	AWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
multi_attach_enabled,
kms_key_id,
encrypted,
size,
auto_enable_io,
outpost_arn,
availability_zone,
throughput,
iops,
snapshot_id,
volume_type,
volume_id,
tags
FROM awscc.ec2.volume
WHERE data__Identifier = '<VolumeId>';

Permissions

To operate on the volume resource, the following permissions are required:

Read

ec2:DescribeVolumes,
ec2:DescribeVolumeAttribute,
ec2:DescribeTags

Update

ec2:ModifyVolume,
ec2:ModifyVolumeAttribute,
ec2:DescribeVolumeAttribute,
ec2:DescribeVolumesModifications,
ec2:DescribeVolumes,
ec2:CreateTags,
ec2:DeleteTags

Delete

ec2:DeleteVolume,
ec2:CreateSnapshot,
ec2:DescribeSnapshots,
ec2:DeleteTags,
ec2:DescribeVolumes