Network.AWS.EC2.CopySnapshot

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.

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.

For more information, see Copying an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide.

See: AWS API Reference for CopySnapshot.

Creating a Request

copySnapshot

Arguments

:: Text

csSourceRegion

-> Text

csSourceSnapshotId

-> CopySnapshot

Creates a value of CopySnapshot with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• csPresignedURL
• csEncrypted
• csDestinationRegion
• csKMSKeyId
• csDescription
• csDryRun
• csSourceRegion
• csSourceSnapshotId

data CopySnapshot

See: copySnapshot smart constructor.

Instances

Eq CopySnapshot

Data CopySnapshot

Read CopySnapshot

Show CopySnapshot

Generic CopySnapshot

AWSRequest CopySnapshot

ToPath CopySnapshot

ToHeaders CopySnapshot

ToQuery CopySnapshot

type Rep CopySnapshot

type Rs CopySnapshot = CopySnapshotResponse

Request Lenses

csPresignedURL :: Lens' CopySnapshot (Maybe Text)

The pre-signed URL that facilitates copying an encrypted snapshot. This parameter is only required when copying an encrypted snapshot with the Amazon EC2 Query API; it is available as an optional parameter in all other cases. 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.

csEncrypted :: Lens' CopySnapshot (Maybe Bool)

Specifies whether the destination snapshot should be encrypted. There is no way to create an unencrypted snapshot copy from an encrypted snapshot; however, you can encrypt a copy of an unencrypted snapshot with this flag. The default CMK for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

csDestinationRegion :: Lens' CopySnapshot (Maybe Text)

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.

CopySnapshot sends the snapshot copy to the regional endpoint that you send the HTTP request to, such as 'ec2.us-east-1.amazonaws.com' (in the AWS CLI, this is specified with the '--region' parameter or the default region in your AWS configuration file).

csKMSKeyId :: Lens' CopySnapshot (Maybe Text)

The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when creating the snapshot copy. 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. The 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. The specified CMK must exist in the region that the snapshot is being copied to. If a KmsKeyId is specified, the Encrypted flag must also be set.

csDescription :: Lens' CopySnapshot (Maybe Text)

A description for the EBS snapshot.

csDryRun :: Lens' CopySnapshot (Maybe Bool)

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.

csSourceRegion :: Lens' CopySnapshot Text

The ID of the region that contains the snapshot to be copied.

csSourceSnapshotId :: Lens' CopySnapshot Text

The ID of the EBS snapshot to copy.

Destructuring the Response

copySnapshotResponse

Arguments

:: Int

csrsResponseStatus

-> CopySnapshotResponse

Creates a value of CopySnapshotResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• csrsSnapshotId
• csrsResponseStatus

data CopySnapshotResponse

See: copySnapshotResponse smart constructor.

Instances

Eq CopySnapshotResponse

Data CopySnapshotResponse

Read CopySnapshotResponse

Show CopySnapshotResponse

Generic CopySnapshotResponse

type Rep CopySnapshotResponse

Response Lenses

csrsSnapshotId :: Lens' CopySnapshotResponse (Maybe Text)

The ID of the new snapshot.

csrsResponseStatus :: Lens' CopySnapshotResponse Int

The response status code.