Data Source schema for AWS::EC2::Volume
id
(String) Uniquely identifies the resource.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.availability_zone
(String) The ID of the Availability Zone in which to create the volume. For example, us-east-1a
.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 in the Amazon Elastic Compute Cloud User Guide.
Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.iops
(Number) 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.
The following are the supported values for each volume type:
gp3
: 3,000 - 16,000 IOPSio1
: 100 - 64,000 IOPSio2
: 100 - 256,000 IOPSFor io2
volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.
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.
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
.
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.
Alternatively, if you want to specify a different key, you can specify one of the following:
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
.multi_attach_enabled
(Boolean) Indicates whether Amazon EBS Multi-Attach is enabled.
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.outpost_arn
(String) The Amazon Resource Name (ARN) of the Outpost.size
(Number) 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.
The following are the supported volumes sizes for each volume type:
gp2
and gp3
: 1 - 16,384 GiBio1
: 4 - 16,384 GiBio2
: 4 - 65,536 GiBst1
and sc1
: 125 - 16,384 GiBstandard
: 1 - 1024 GiBsnapshot_id
(String) The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.tags
(Attributes List) The tags to apply to the volume during creation. (see below for nested schema)throughput
(Number) The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
This parameter is valid only for gp3
volumes. The default value is 125.
Valid Range: Minimum value of 125. Maximum value of 1000.volume_id
(String)volume_type
(String) The volume type. This parameter can be one of the following values:
gp2
| gp3
io1
| io2
st1
sc1
standard
For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.
Default: gp2
tags
Read-Only:
key
(String) The tag key.value
(String) The tag value.