Creates an EBS volume that can be attached to an instance in the same Availability Zone.
You can create a new empty volume or restore a volume from an EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume.
You can create encrypted volumes. Encrypted volumes must be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
You can tag your volumes during creation. For more information, see Tagging your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.
For more information, see Creating an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide.
ec2_create_volume(AvailabilityZone, Encrypted, Iops, KmsKeyId,
OutpostArn, Size, SnapshotId, VolumeType, DryRun, TagSpecifications,
MultiAttachEnabled, Throughput)A list with the following syntax:
list(
Attachments = list(
list(
AttachTime = as.POSIXct(
"2015-01-01"
),
Device = "string",
InstanceId = "string",
State = "attaching"|"attached"|"detaching"|"detached"|"busy",
VolumeId = "string",
DeleteOnTermination = TRUE|FALSE
)
),
AvailabilityZone = "string",
CreateTime = as.POSIXct(
"2015-01-01"
),
Encrypted = TRUE|FALSE,
KmsKeyId = "string",
OutpostArn = "string",
Size = 123,
SnapshotId = "string",
State = "creating"|"available"|"in-use"|"deleting"|"deleted"|"error",
VolumeId = "string",
Iops = 123,
Tags = list(
list(
Key = "string",
Value = "string"
)
),
VolumeType = "standard"|"io1"|"io2"|"gp2"|"sc1"|"st1"|"gp3",
FastRestored = TRUE|FALSE,
MultiAttachEnabled = TRUE|FALSE,
Throughput = 123
)
[required] The Availability Zone in which to create the volume.
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.
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-64,000 IOPS
For io1 and io2 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 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 AWS Key Management Service (AWS KMS) customer
master key (CMK) to use for Amazon EBS encryption. If this parameter is
not specified, your AWS managed CMK for EBS is used. If KmsKeyId is
specified, the encrypted state must be true.
You can specify the CMK 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.
AWS authenticates the CMK 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.
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
io1 and io2: 4-16,384
st1 and sc1: 125-16,384
standard: 1-1,024
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
For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud 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 Elastic Compute Cloud 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.
svc$create_volume(
AvailabilityZone = "string",
Encrypted = TRUE|FALSE,
Iops = 123,
KmsKeyId = "string",
OutpostArn = "string",
Size = 123,
SnapshotId = "string",
VolumeType = "standard"|"io1"|"io2"|"gp2"|"sc1"|"st1"|"gp3",
DryRun = TRUE|FALSE,
TagSpecifications = list(
list(
ResourceType = "client-vpn-endpoint"|"customer-gateway"|"dedicated-host"|"dhcp-options"|"egress-only-internet-gateway"|"elastic-ip"|"elastic-gpu"|"export-image-task"|"export-instance-task"|"fleet"|"fpga-image"|"host-reservation"|"image"|"import-image-task"|"import-snapshot-task"|"instance"|"internet-gateway"|"key-pair"|"launch-template"|"local-gateway-route-table-vpc-association"|"natgateway"|"network-acl"|"network-interface"|"network-insights-analysis"|"network-insights-path"|"placement-group"|"reserved-instances"|"route-table"|"security-group"|"snapshot"|"spot-fleet-request"|"spot-instances-request"|"subnet"|"traffic-mirror-filter"|"traffic-mirror-session"|"traffic-mirror-target"|"transit-gateway"|"transit-gateway-attachment"|"transit-gateway-connect-peer"|"transit-gateway-multicast-domain"|"transit-gateway-route-table"|"volume"|"vpc"|"vpc-peering-connection"|"vpn-connection"|"vpn-gateway"|"vpc-flow-log",
Tags = list(
list(
Key = "string",
Value = "string"
)
)
)
),
MultiAttachEnabled = TRUE|FALSE,
Throughput = 123
)
if (FALSE) {
# This example creates an 80 GiB General Purpose (SSD) volume in the
# Availability Zone `us-east-1a`.
svc$create_volume(
AvailabilityZone = "us-east-1a",
Size = 80L,
VolumeType = "gp2"
)
# This example creates a new Provisioned IOPS (SSD) volume with 1000
# provisioned IOPS from a snapshot in the Availability Zone
# `us-east-1a`.
svc$create_volume(
AvailabilityZone = "us-east-1a",
Iops = 1000L,
SnapshotId = "snap-066877671789bd71b",
VolumeType = "io1"
)
}
Run the code above in your browser using DataLab