Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy the snapshot within the same Region or from one Region to another. You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs).
Copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless you enable encryption for the snapshot copy operation. By default, encrypted snapshot copies use the default AWS Key Management Service (AWS KMS) customer master key (CMK); however, you can specify a different CMK.
To copy an encrypted snapshot that has been shared from another account, you must have permissions for the CMK used to encrypt the snapshot.
Snapshots created by copying another snapshot have an arbitrary volume ID that should not be used for any purpose.
For more information, see Copying an Amazon EBS snapshot in the Amazon Elastic Compute Cloud User Guide.
ec2_copy_snapshot(Description, DestinationRegion, Encrypted, KmsKeyId,
PresignedUrl, SourceRegion, SourceSnapshotId, TagSpecifications, DryRun)A list with the following syntax:
list(
SnapshotId = "string",
Tags = list(
list(
Key = "string",
Value = "string"
)
)
)
A description for the EBS snapshot.
The destination Region to use in the PresignedUrl parameter of a
snapshot copy operation. This parameter is only valid for specifying the
destination Region in a PresignedUrl parameter, where it is required.
The snapshot copy is sent to the regional endpoint that you sent the
HTTP request to (for example, ec2.us-east-1.amazonaws.com). With the
AWS CLI, this is specified using the --region parameter or the default
Region in your AWS configuration file.
To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Otherwise, omit this parameter. Encrypted snapshots are encrypted, even if you omit this parameter and encryption by default is not enabled. You cannot set this parameter to false. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
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.
When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL. This parameter is optional for unencrypted snapshots. For more information, see Query requests.
The PresignedUrl should use the snapshot source endpoint, the
copy_snapshot action, and include the
SourceRegion, SourceSnapshotId, and DestinationRegion parameters.
The PresignedUrl must be signed using AWS Signature Version 4. Because
EBS snapshots are stored in Amazon S3, the signing algorithm for this
parameter uses the same logic that is described in Authenticating Requests: Using Query Parameters (AWS Signature Version 4)
in the Amazon Simple Storage Service API Reference. An invalid or
improperly signed PresignedUrl will cause the copy operation to fail
asynchronously, and the snapshot will move to an error state.
[required] The ID of the Region that contains the snapshot to be copied.
[required] The ID of the EBS snapshot to copy.
The tags to apply to the new snapshot.
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.
svc$copy_snapshot(
Description = "string",
DestinationRegion = "string",
Encrypted = TRUE|FALSE,
KmsKeyId = "string",
PresignedUrl = "string",
SourceRegion = "string",
SourceSnapshotId = "string",
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"
)
)
)
),
DryRun = TRUE|FALSE
)
if (FALSE) {
# This example copies a snapshot with the snapshot ID of
# `snap-066877671789bd71b` from the `us-west-2` region to the
# `us-east-1` region and adds a short description to identify the
# snapshot.
svc$copy_snapshot(
Description = "This is my copied snapshot.",
DestinationRegion = "us-east-1",
SourceRegion = "us-west-2",
SourceSnapshotId = "snap-066877671789bd71b"
)
}
Run the code above in your browser using DataLab