Creates an EBS volume that can be attached to an instance in the same Availability Zone.
See https://www.paws-r-sdk.com/docs/ec2_create_volume/ for full documentation.
ec2_create_volume(
AvailabilityZone,
Encrypted = NULL,
Iops = NULL,
KmsKeyId = NULL,
OutpostArn = NULL,
Size = NULL,
SnapshotId = NULL,
VolumeType = NULL,
DryRun = NULL,
TagSpecifications = NULL,
MultiAttachEnabled = NULL,
Throughput = NULL,
ClientToken = NULL
)
[required] The ID of the Availability Zone in which to create the volume. For
example, us-east-1a
.
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 EBS User Guide.
Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.
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 IOPS
io1
: 100 - 64,000 IOPS
io2
: 100 - 256,000 IOPS
For 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.
The identifier of the KMS key to use for Amazon EBS encryption. If this
parameter is not specified, your KMS key for Amazon EBS is used. If
KmsKeyId
is specified, the encrypted state must be true
.
You can specify the KMS key using any of the following:
Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
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.
Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
The Amazon Resource Name (ARN) of the Outpost on which to create the volume.
If you intend to use a volume with an instance running on an outpost, then you must create the volume on the same outpost as the instance. You can't use a volume created in an Amazon Web Services Region with an instance on an Amazon Web Services outpost, or the other way around.
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 GiB
io1
: 4 - 16,384 GiB
io2
: 4 - 65,536 GiB
st1
and sc1
: 125 - 16,384 GiB
standard
: 1 - 1024 GiB
The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
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
Throughput Optimized HDD (st1
) and Cold HDD (sc1
) volumes can't be
used as boot volumes.
For more information, see Amazon EBS volume types in the Amazon EBS User Guide.
Default: gp2
Checks whether you have the required permissions for the action, without
actually making the request, and provides an error response. If you have
the required permissions, the error response is DryRunOperation
.
Otherwise, it is UnauthorizedOperation
.
The tags to apply to the volume during creation.
Indicates whether to enable Amazon EBS Multi-Attach. If you enable
Multi-Attach, you can attach the volume to up to 16 Instances built on the Nitro System
in the same Availability Zone. This parameter is supported with io1
and io2
volumes only. For more information, see Amazon EBS Multi-Attach
in the Amazon EBS User Guide.
The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
This parameter is valid only for gp3
volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.