Creates a crash-consistent, point-in-time copy of an existing Amazon EBS volume within the same Availability Zone¶

Description¶

Creates a crash-consistent, point-in-time copy of an existing Amazon EBS volume within the same Availability Zone. The volume copy can be attached to an Amazon EC2 instance once it reaches the available state. For more information, see Copy an Amazon EBS volume.

Usage¶

ec2_copy_volumes(SourceVolumeId, Iops, Size, VolumeType, DryRun,
  TagSpecifications, MultiAttachEnabled, Throughput, ClientToken,
  Encrypted, KmsKeyId)

Arguments¶

SourceVolumeId

[required] The ID of the source EBS volume to copy.
Iops

The number of I/O operations per second (IOPS) to provision for the volume copy. Required for io1 and io2 volumes. Optional for gp3 volumes. Omit for all other volume types. Full provisioned IOPS performance can be achieved only once the volume copy is fully initialized.

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

The size of the volume copy, in GiBs. The size must be equal to or greater than the size of the source volume. If not specified, the size defaults to the size of the source volume.

Maximum supported sizes:
- gp2: 16,384 GiB
- gp3: 65,536 GiB
- io1: 16,384 GiB
- io2: 65,536 GiB
- st1 and sc1: 16,384 GiB
- standard: 1024 GiB
VolumeType

The volume type for the volume copy. If not specified, the volume type defaults to gp2.
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.
TagSpecifications

The tags to apply to the volume copy during creation.
MultiAttachEnabled

Indicates whether to enable Amazon EBS Multi-Attach for the volume copy. If you enable Multi-Attach, you can attach the volume to up to 16 Nitro instances in the same Availability Zone simultaneously. Supported with io1 and io2 volumes only. For more information, see Amazon EBS Multi-Attach.
Throughput

The throughput to provision for the volume copy, in MiB/s. Supported for gp3 volumes only. Omit for all other volume types. Full provisioned throughput performance can be achieved only once the volume copy is fully initialized.

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

Indicates whether to encrypt the volume copy. If the source volume is encrypted, the service always encrypts the copy regardless of this value. Set to true to encrypt a copy of an unencrypted source volume during the copy operation. If you set Encrypted to true but do not specify KmsKeyId, the service uses the default KMS key for EBS encryption in your account.
KmsKeyId

The identifier of the KMS key to use for encryption of the volume copy. Specify a symmetric encryption KMS key. You can specify a KMS key using the key ID, key ARN, alias name, or alias ARN. If you set Encrypted to true but do not specify this parameter, the service uses the default KMS key for EBS encryption in your account. For cross-account volume copies, this must be a KMS key in the calling account.

Value¶

A list with the following syntax:

list(
  Volumes = list(
    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$copy_volumes(
  SourceVolumeId = "string",
  Iops = 123,
  Size = 123,
  VolumeType = "standard"|"io1"|"io2"|"gp2"|"sc1"|"st1"|"gp3",
  DryRun = TRUE|FALSE,
  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",
  Encrypted = TRUE|FALSE,
  KmsKeyId = "string"
)