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). The snapshot is copied to the regional endpoint that you send the HTTP request to.
ec2_copy_snapshot(Description, DestinationRegion, Encrypted, KmsKeyId,
PresignedUrl, SourceRegion, SourceSnapshotId, DryRun)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.
Specifies whether the destination snapshot should be encrypted. You can
encrypt a copy of an unencrypted snapshot, but you cannot use it to
create an unencrypted copy of an encrypted snapshot. Your default CMK
for EBS is used unless you specify a non-default AWS Key Management
Service (AWS KMS) CMK using KmsKeyId. For more information, see
Amazon EBS Encryption
in the Amazon Elastic Compute Cloud User Guide.
An identifier for the AWS Key Management Service (AWS KMS) customer
master key (CMK) to use when creating the encrypted volume. This
parameter is only required if you want to use a non-default CMK; if this
parameter is not specified, the default CMK for EBS is used. If a
KmsKeyId is specified, the Encrypted flag must also be set.
The CMK identifier may be provided in any of the following formats:
Key ID
Key alias
ARN using key ID. The ID ARN contains the arn:aws:kms namespace,
followed by the region of the CMK, the AWS account ID of the CMK
owner, the key namespace, and then the CMK ID. For example,
arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms
namespace, followed by the region of the CMK, the AWS account ID of
the CMK owner, the alias namespace, and then the CMK alias. For
example,
arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS parses KmsKeyId asynchronously, meaning that the action you call
may appear to complete even though you provided an invalid identifier.
The action will eventually fail.
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
CopySnapshot 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 by 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.
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", DryRun = TRUE|FALSE )
Copies of encrypted EBS snapshots remain encrypted. Copies of
unencrypted snapshots remain unencrypted, unless the Encrypted flag is
specified during 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 non-default CMK
with the KmsKeyId parameter.
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.
# NOT RUN {
# 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.
# }
# NOT RUN {
svc$copy_snapshot(
Description = "This is my copied snapshot.",
DestinationRegion = "us-east-1",
SourceRegion = "us-west-2",
SourceSnapshotId = "snap-066877671789bd71b"
)
# }
# NOT RUN {
# }
Run the code above in your browser using DataLab