Creates an EBS volume that can be attached to an instance in the same Availability Zone¶

Description¶

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 Amazon Web Services 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 EBS User Guide.

You can tag your volumes during creation. For more information, see Tag your Amazon EC2 resources in the Amazon EC2 User Guide.

For more information, see Create an Amazon EBS volume in the Amazon EBS User Guide.

Usage¶

ec2_create_volume(AvailabilityZone, AvailabilityZoneId, Encrypted, Iops,
  KmsKeyId, OutpostArn, Size, SnapshotId, VolumeType, TagSpecifications,
  MultiAttachEnabled, Throughput, ClientToken, VolumeInitializationRate,
  Operator, DryRun)

Arguments¶

AvailabilityZone

The ID of the Availability Zone in which to create the volume. For example, us-east-1a.

Either AvailabilityZone or AvailabilityZoneId must be specified, but not both.
AvailabilityZoneId

The ID of the Availability Zone in which to create the volume. For example, use1-az1.

Either AvailabilityZone or AvailabilityZoneId must be specified, but not both.
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 EBS User Guide.

Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.
Iops

The number of I/O operations per second (IOPS) to provision for the volume. Required for io1 and io2 volumes. Optional for gp3 volumes. Omit for all other volume types.

Valid ranges:
- gp3: 3,000(default)- 80,000 IOPS
- io1: 100 - 64,000 IOPS
- io2: 100 - 256,000 IOPS
Instances built on the Nitro System can support up to 256,000 IOPS. Other instances can support up to 32,000 IOPS.
KmsKeyId

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.
OutpostArn

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.
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, and you can specify a volume size that is equal to or larger than the snapshot size.

Valid sizes:
- gp2: 1 - 16,384 GiB
- gp3: 1 - 65,536 GiB
- io1: 4 - 16,384 GiB
- io2: 4 - 65,536 GiB
- st1 and sc1: 125 - 16,384 GiB
- standard: 1 - 1024 GiB
SnapshotId

The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
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
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
TagSpecifications

The tags to apply to the volume during creation.
MultiAttachEnabled

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.
Throughput

The throughput to provision for the volume, in MiB/s. Supported for gp3 volumes only. Omit for all other volume types.

Valid Range: 125 - 2000 MiB/s
ClientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.
VolumeInitializationRate

Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This is also known as volume initialization. Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation.

This parameter is supported only for volumes created from snapshots. Omit this parameter if:
- You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation.
  
  If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore. - You want to create a volume that is initialized at the default rate.
For more information, see Initialize Amazon EBS volumes in the Amazon EC2 User Guide.

Valid range: 100 - 300 MiB/s
Operator

Reserved for internal use.
DryRun

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.

Value¶

A list with the following syntax:

list(
  AvailabilityZoneId = "string",
  OutpostArn = "string",
  SourceVolumeId = "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,
  SseType = "sse-ebs"|"sse-kms"|"none",
  Operator = list(
    Managed = TRUE|FALSE,
    Principal = "string",
    HiddenByDefault = TRUE|FALSE
  ),
  VolumeInitializationRate = 123,
  VolumeArn = "string",
  OwnerId = "string",
  VolumeId = "string",
  Size = 123,
  SnapshotId = "string",
  AvailabilityZone = "string",
  State = "creating"|"available"|"in-use"|"deleting"|"deleted"|"error",
  CreateTime = as.POSIXct(
    "2015-01-01"
  ),
  Attachments = list(
    list(
      DeleteOnTermination = TRUE|FALSE,
      AssociatedResource = "string",
      InstanceOwningService = "string",
      EbsCardIndex = 123,
      VolumeId = "string",
      InstanceId = "string",
      Device = "string",
      State = "attaching"|"attached"|"detaching"|"detached"|"busy",
      AttachTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  Encrypted = TRUE|FALSE,
  KmsKeyId = "string"
)

Request syntax¶

svc$create_volume(
  AvailabilityZone = "string",
  AvailabilityZoneId = "string",
  Encrypted = TRUE|FALSE,
  Iops = 123,
  KmsKeyId = "string",
  OutpostArn = "string",
  Size = 123,
  SnapshotId = "string",
  VolumeType = "standard"|"io1"|"io2"|"gp2"|"sc1"|"st1"|"gp3",
  TagSpecifications = list(
    list(
      ResourceType = "capacity-reservation"|"client-vpn-endpoint"|"customer-gateway"|"carrier-gateway"|"coip-pool"|"declarative-policies-report"|"dedicated-host"|"dhcp-options"|"egress-only-internet-gateway"|"elastic-ip"|"elastic-gpu"|"export-image-task"|"export-instance-task"|"fleet"|"fpga-image"|"host-reservation"|"image"|"image-usage-report"|"import-image-task"|"import-snapshot-task"|"instance"|"instance-event-window"|"internet-gateway"|"ipam"|"ipam-pool"|"ipam-scope"|"ipv4pool-ec2"|"ipv6pool-ec2"|"key-pair"|"launch-template"|"local-gateway"|"local-gateway-route-table"|"local-gateway-virtual-interface"|"local-gateway-virtual-interface-group"|"local-gateway-route-table-vpc-association"|"local-gateway-route-table-virtual-interface-group-association"|"natgateway"|"network-acl"|"network-interface"|"network-insights-analysis"|"network-insights-path"|"network-insights-access-scope"|"network-insights-access-scope-analysis"|"outpost-lag"|"placement-group"|"prefix-list"|"replace-root-volume-task"|"reserved-instances"|"route-table"|"security-group"|"security-group-rule"|"service-link-virtual-interface"|"snapshot"|"spot-fleet-request"|"spot-instances-request"|"subnet"|"subnet-cidr-reservation"|"traffic-mirror-filter"|"traffic-mirror-session"|"traffic-mirror-target"|"transit-gateway"|"transit-gateway-attachment"|"transit-gateway-connect-peer"|"transit-gateway-multicast-domain"|"transit-gateway-policy-table"|"transit-gateway-metering-policy"|"transit-gateway-route-table"|"transit-gateway-route-table-announcement"|"volume"|"vpc"|"vpc-endpoint"|"vpc-endpoint-connection"|"vpc-endpoint-service"|"vpc-endpoint-service-permission"|"vpc-peering-connection"|"vpn-connection"|"vpn-gateway"|"vpc-flow-log"|"capacity-reservation-fleet"|"traffic-mirror-filter-rule"|"vpc-endpoint-connection-device-type"|"verified-access-instance"|"verified-access-group"|"verified-access-endpoint"|"verified-access-policy"|"verified-access-trust-provider"|"vpn-connection-device-type"|"vpc-block-public-access-exclusion"|"vpc-encryption-control"|"route-server"|"route-server-endpoint"|"route-server-peer"|"ipam-resource-discovery"|"ipam-resource-discovery-association"|"instance-connect-endpoint"|"verified-access-endpoint-target"|"ipam-external-resource-verification-token"|"capacity-block"|"mac-modification-task"|"ipam-prefix-list-resolver"|"ipam-policy"|"ipam-prefix-list-resolver-target"|"ipam-internet-registry-association"|"secondary-interface"|"secondary-network"|"secondary-subnet"|"capacity-manager-data-export"|"vpn-concentrator"|"ipam-pool-allocation"|"capacity-reservation-cancellation-quote"|"application-status-check"|"capacity-reservation-modification-quote",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  ),
  MultiAttachEnabled = TRUE|FALSE,
  Throughput = 123,
  ClientToken = "string",
  VolumeInitializationRate = 123,
  Operator = list(
    Principal = "string"
  ),
  DryRun = TRUE|FALSE
)

Examples¶

# 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"
)