AWS::EC2::Volume
Specifies an Amazon Elastic Block Store (Amazon EBS) volume.
When you use AWS CloudFormation to update an Amazon EBS volume that modifies Iops
, Size
,
or VolumeType
, there is a cooldown period before another operation can occur. This can cause your
stack to report being in
UPDATE_IN_PROGRESS
or UPDATE_ROLLBACK_IN_PROGRESS
for long periods of time.
Amazon EBS does not support sizing down an Amazon EBS volume. AWS CloudFormation will not attempt to modify an Amazon EBS volume to a smaller size on rollback.
Some common scenarios when you might encounter a cooldown period for Amazon EBS include:
-
You successfully update an Amazon EBS volume and the update succeeds. When you attempt another update within the cooldown window, that update will be subject to a cooldown period.
-
You successfully update an Amazon EBS volume and the update succeeds but another change in your
update-stack
call fails. The rollback will be subject to a cooldown period.
For more information on the cooldown period, see Requirements for Modifying EBS Volumes.
To control how AWS CloudFormation handles the volume when the stack is deleted, set a deletion policy for your volume. You can choose to retain the volume, to delete the volume, or to create a snapshot of the volume. For more information, see DeletionPolicy Attribute.
If you set a deletion policy that creates a snapshot, all tags on the volume are included in the snapshot.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::EC2::Volume", "Properties" : { "AutoEnableIO" :
Boolean
, "AvailabilityZone" :String
, "Encrypted" :Boolean
, "Iops" :Integer
, "KmsKeyId" :String
, "MultiAttachEnabled" :Boolean
, "OutpostArn" :String
, "Size" :Integer
, "SnapshotId" :String
, "Tags" :[ Tag, ... ]
, "Throughput" :Integer
, "VolumeType" :String
} }
YAML
Type: AWS::EC2::Volume Properties: AutoEnableIO:
Boolean
AvailabilityZone:String
Encrypted:Boolean
Iops:Integer
KmsKeyId:String
MultiAttachEnabled:Boolean
OutpostArn:String
Size:Integer
SnapshotId:String
Tags:- Tag
Throughput:Integer
VolumeType:String
Properties
AutoEnableIO
-
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.
Required: No
Type: Boolean
Update requires: No interruption
AvailabilityZone
-
The Availability Zone in which to create the volume.
Required: Yes
Type: String
Update requires: Updates are not supported.
Encrypted
-
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.
Required: No
Type: Boolean
Update requires: Updates are not supported.
Iops
-
The number of I/O operations per second (IOPS). For
gp3
,io1
, andio2
volumes, this represents the number of IOPS that are provisioned for the volume. Forgp2
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 IOPS -
io1
: 100-64,000 IOPS -
io2
: 100-64,000 IOPS
For
io1
andio2
volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System. Other instance families guarantee performance up to 32,000 IOPS.This parameter is required for
io1
andio2
volumes. The default forgp3
volumes is 3,000 IOPS. This parameter is not supported forgp2
,st1
,sc1
, orstandard
volumes.Required: No
Type: Integer
Update requires: No interruption
-
KmsKeyId
-
The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If
KmsKeyId
is specified, the encrypted state must betrue
.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 CMK specified for your account. If your account does not have a default CMK, then the volume is encrypted using the AWS managed CMK.Alternatively, if you want to specify a different CMK, you can specify one of the following:
-
Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
-
Key alias. Specify the alias for the CMK, prefixed with
alias/
. For example, for a CMK with the aliasmy_cmk
, usealias/my_cmk
. Or to specify the AWS managed CMK, usealias/aws/ebs
. -
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
-
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Required: No
Type: String
Update requires: Updates are not supported.
-
MultiAttachEnabled
-
Indicates whether Amazon EBS Multi-Attach is enabled.
Note AWS CloudFormation 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.
Required: No
Type: Boolean
Update requires: No interruption
OutpostArn
-
The Amazon Resource Name (ARN) of the Outpost.
Required: No
Type: String
Update requires: No interruption
Size
-
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
andgp3
: 1-16,384 -
io1
andio2
: 4-16,384 -
st1
andsc1
: 125-16,384 -
standard
: 1-1,024
Required: No
Type: Integer
Update requires: No interruption
-
SnapshotId
-
The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
Required: No
Type: String
Update requires: Updates are not supported.
Tags
-
The tags to apply to the volume during creation.
Required: No
Type: List of Tag
Update requires: No interruption
Throughput
-
The throughput that the volume supports, in MiB/s.
Required: No
Type: Integer
Update requires: No interruption
VolumeType
-
The volume type. This parameter can be one of the following values:
-
General Purpose SSD:
gp2
|gp3
-
Provisioned IOPS SSD:
io1
|io2
-
Throughput Optimized HDD:
st1
-
Cold HDD:
sc1
-
Magnetic:
standard
For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.
Default:
gp2
Required: No
Type: String
Allowed values:
gp2 | gp3 | io1 | io2 | sc1 | st1 | standard
Update requires: No interruption
-
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the resource name. For example: vol-5cb85026
.
For more information about using the Ref
function, see Ref.
Examples
Encrypted Amazon EBS Volume with DeletionPolicy to Make a Snapshot on Delete
JSON
"NewVolume" : { "Type" : "AWS::EC2::Volume", "Properties" : { "Size" : "100", "Encrypted" : "true", "AvailabilityZone" : { "Fn::GetAtt" : [ "Ec2Instance", "AvailabilityZone" ] }, "Tags" : [ { "Key" : "MyTag", "Value" : "TagValue" } ] }, "DeletionPolicy" : "Snapshot" }
YAML
NewVolume: Type: AWS::EC2::Volume Properties: Size: 100 Encrypted: true AvailabilityZone: !GetAtt Ec2Instance.AvailabilityZone Tags: - Key: MyTag Value: TagValue DeletionPolicy: Snapshot
Amazon EBS Volume with 100 Provisioned IOPS
JSON
"NewVolume" : { "Type" : "AWS::EC2::Volume", "Properties" : { "Size" : "100", "VolumeType" : "io1", "Iops" : "100", "AvailabilityZone" : { "Fn::GetAtt" : [ "EC2Instance", "AvailabilityZone" ] } } }
YAML
NewVolume: Type: AWS::EC2::Volume Properties: Size: 100 VolumeType: io1 Iops: 100 AvailabilityZone: !GetAtt Ec2Instance.AvailabilityZone
See also
-
CreateVolume in the Amazon Elastic Compute Cloud API Reference