Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy a snapshot within the same Region, from one Region to another, or from a Region to an Outpost. You can't copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.
You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs).
When copying snapshots to a Region, 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 Key Management Service (KMS) KMS key; however, you can specify a different KMS key. To copy an encrypted snapshot that has been shared from another account, you must have permissions for the KMS key used to encrypt the snapshot.
Snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using KmsKeyId. Outposts do not support unencrypted snapshots. For more information, Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.
Snapshots created by copying another snapshot have an arbitrary volume ID that should not be used for any purpose.
For more information, see Copy an Amazon EBS snapshot in the Amazon Elastic Compute Cloud User Guide.
Synopsis
- data CopySnapshot = CopySnapshot' {}
- newCopySnapshot :: Text -> Text -> CopySnapshot
- copySnapshot_description :: Lens' CopySnapshot (Maybe Text)
- copySnapshot_destinationOutpostArn :: Lens' CopySnapshot (Maybe Text)
- copySnapshot_destinationRegion :: Lens' CopySnapshot (Maybe Text)
- copySnapshot_dryRun :: Lens' CopySnapshot (Maybe Bool)
- copySnapshot_encrypted :: Lens' CopySnapshot (Maybe Bool)
- copySnapshot_kmsKeyId :: Lens' CopySnapshot (Maybe Text)
- copySnapshot_presignedUrl :: Lens' CopySnapshot (Maybe Text)
- copySnapshot_tagSpecifications :: Lens' CopySnapshot (Maybe [TagSpecification])
- copySnapshot_sourceRegion :: Lens' CopySnapshot Text
- copySnapshot_sourceSnapshotId :: Lens' CopySnapshot Text
- data CopySnapshotResponse = CopySnapshotResponse' {
- snapshotId :: Maybe Text
- tags :: Maybe [Tag]
- httpStatus :: Int
- newCopySnapshotResponse :: Int -> CopySnapshotResponse
- copySnapshotResponse_snapshotId :: Lens' CopySnapshotResponse (Maybe Text)
- copySnapshotResponse_tags :: Lens' CopySnapshotResponse (Maybe [Tag])
- copySnapshotResponse_httpStatus :: Lens' CopySnapshotResponse Int
Creating a Request
data CopySnapshot Source #
See: newCopySnapshot
smart constructor.
CopySnapshot' | |
|
Instances
Create a value of CopySnapshot
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CopySnapshot
, copySnapshot_description
- A description for the EBS snapshot.
$sel:destinationOutpostArn:CopySnapshot'
, copySnapshot_destinationOutpostArn
- The Amazon Resource Name (ARN) of the Outpost to which to copy the
snapshot. Only specify this parameter when copying a snapshot from an
Amazon Web Services Region to an Outpost. The snapshot must be in the
Region for the destination Outpost. You cannot copy a snapshot from an
Outpost to a Region, from one Outpost to another, or within the same
Outpost.
For more information, see Copy snapshots from an Amazon Web Services Region to an Outpost in the Amazon Elastic Compute Cloud User Guide.
$sel:destinationRegion:CopySnapshot'
, copySnapshot_destinationRegion
- 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
CLI, this is specified using the --region
parameter or the default
Region in your Amazon Web Services configuration file.
$sel:dryRun:CopySnapshot'
, copySnapshot_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
.
CopySnapshot
, copySnapshot_encrypted
- 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.
CopySnapshot
, copySnapshot_kmsKeyId
- The identifier of the Key Management Service (KMS) 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.
$sel:presignedUrl:CopySnapshot'
, copySnapshot_presignedUrl
- 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 Amazon Web Services 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 (Amazon Web Services 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.
CopySnapshot
, copySnapshot_tagSpecifications
- The tags to apply to the new snapshot.
$sel:sourceRegion:CopySnapshot'
, copySnapshot_sourceRegion
- The ID of the Region that contains the snapshot to be copied.
$sel:sourceSnapshotId:CopySnapshot'
, copySnapshot_sourceSnapshotId
- The ID of the EBS snapshot to copy.
Request Lenses
copySnapshot_description :: Lens' CopySnapshot (Maybe Text) Source #
A description for the EBS snapshot.
copySnapshot_destinationOutpostArn :: Lens' CopySnapshot (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot. Only specify this parameter when copying a snapshot from an Amazon Web Services Region to an Outpost. The snapshot must be in the Region for the destination Outpost. You cannot copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.
For more information, see Copy snapshots from an Amazon Web Services Region to an Outpost in the Amazon Elastic Compute Cloud User Guide.
copySnapshot_destinationRegion :: Lens' CopySnapshot (Maybe Text) Source #
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
CLI, this is specified using the --region
parameter or the default
Region in your Amazon Web Services configuration file.
copySnapshot_dryRun :: Lens' CopySnapshot (Maybe Bool) Source #
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
.
copySnapshot_encrypted :: Lens' CopySnapshot (Maybe Bool) Source #
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.
copySnapshot_kmsKeyId :: Lens' CopySnapshot (Maybe Text) Source #
The identifier of the Key Management Service (KMS) 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.
copySnapshot_presignedUrl :: Lens' CopySnapshot (Maybe Text) Source #
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 Amazon Web Services 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 (Amazon Web Services 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.
copySnapshot_tagSpecifications :: Lens' CopySnapshot (Maybe [TagSpecification]) Source #
The tags to apply to the new snapshot.
copySnapshot_sourceRegion :: Lens' CopySnapshot Text Source #
The ID of the Region that contains the snapshot to be copied.
copySnapshot_sourceSnapshotId :: Lens' CopySnapshot Text Source #
The ID of the EBS snapshot to copy.
Destructuring the Response
data CopySnapshotResponse Source #
See: newCopySnapshotResponse
smart constructor.
CopySnapshotResponse' | |
|
Instances
newCopySnapshotResponse Source #
Create a value of CopySnapshotResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CopySnapshotResponse
, copySnapshotResponse_snapshotId
- The ID of the new snapshot.
CopySnapshotResponse
, copySnapshotResponse_tags
- Any tags applied to the new snapshot.
$sel:httpStatus:CopySnapshotResponse'
, copySnapshotResponse_httpStatus
- The response's http status code.
Response Lenses
copySnapshotResponse_snapshotId :: Lens' CopySnapshotResponse (Maybe Text) Source #
The ID of the new snapshot.
copySnapshotResponse_tags :: Lens' CopySnapshotResponse (Maybe [Tag]) Source #
Any tags applied to the new snapshot.
copySnapshotResponse_httpStatus :: Lens' CopySnapshotResponse Int Source #
The response's http status code.