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 .

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 - 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.
• csEncrypted - Specifies whether the destination snapshot should be encrypted. You can encrypt a copy of an unencrypted snapshot using this flag, but you cannot use it to create an unencrypted copy from an encrypted snapshot. Your 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 - 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.
• csKMSKeyId - 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.
• csDescription - A description for the EBS snapshot.
• csDryRun - 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 - The ID of the region that contains the snapshot to be copied.
• csSourceSnapshotId - The ID of the EBS snapshot to copy.

data CopySnapshot

Contains the parameters for CopySnapshot.

See: copySnapshot smart constructor.

Instances

Eq CopySnapshot

Methods

(==) :: CopySnapshot -> CopySnapshot -> Bool

(/=) :: CopySnapshot -> CopySnapshot -> Bool

Data CopySnapshot

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CopySnapshot -> c CopySnapshot

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CopySnapshot

toConstr :: CopySnapshot -> Constr

dataTypeOf :: CopySnapshot -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CopySnapshot)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CopySnapshot)

gmapT :: (forall b. Data b => b -> b) -> CopySnapshot -> CopySnapshot

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CopySnapshot -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CopySnapshot -> r

gmapQ :: (forall d. Data d => d -> u) -> CopySnapshot -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CopySnapshot -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CopySnapshot -> m CopySnapshot

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CopySnapshot -> m CopySnapshot

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CopySnapshot -> m CopySnapshot

Read CopySnapshot

Methods

readsPrec :: Int -> ReadS CopySnapshot

readList :: ReadS [CopySnapshot]

readPrec :: ReadPrec CopySnapshot

readListPrec :: ReadPrec [CopySnapshot]

Show CopySnapshot

Methods

showsPrec :: Int -> CopySnapshot -> ShowS

show :: CopySnapshot -> String

showList :: [CopySnapshot] -> ShowS

Generic CopySnapshot

Associated Types

type Rep CopySnapshot :: * -> *

Methods

from :: CopySnapshot -> Rep CopySnapshot x

to :: Rep CopySnapshot x -> CopySnapshot

Hashable CopySnapshot

Methods

hashWithSalt :: Int -> CopySnapshot -> Int

hash :: CopySnapshot -> Int

NFData CopySnapshot

Methods

rnf :: CopySnapshot -> ()

AWSRequest CopySnapshot

Associated Types

type Rs CopySnapshot :: *

Methods

request :: CopySnapshot -> Request CopySnapshot

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * CopySnapshot -> ClientResponse -> m (Response CopySnapshot)

ToHeaders CopySnapshot

Methods

toHeaders :: CopySnapshot -> [Header]

ToPath CopySnapshot

Methods

toPath :: CopySnapshot -> ByteString

ToQuery CopySnapshot

Methods

toQuery :: CopySnapshot -> QueryString

type Rep CopySnapshot

type Rep CopySnapshot = D1 * (MetaData "CopySnapshot" "Network.AWS.EC2.CopySnapshot" "amazonka-ec2-1.6.0-Kkew7Kpgof6EYi20Z0WOzs" False) (C1 * (MetaCons "CopySnapshot'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_csPresignedURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_csEncrypted") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_csDestinationRegion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_csKMSKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_csDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_csDryRun") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_csSourceRegion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_csSourceSnapshotId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))))

type Rs CopySnapshot

type Rs CopySnapshot = CopySnapshotResponse

Request Lenses

csPresignedURL :: Lens' CopySnapshot (Maybe Text)

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.

csEncrypted :: Lens' CopySnapshot (Maybe Bool)

Specifies whether the destination snapshot should be encrypted. You can encrypt a copy of an unencrypted snapshot using this flag, but you cannot use it to create an unencrypted copy from an encrypted snapshot. Your 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.

csKMSKeyId :: Lens' CopySnapshot (Maybe Text)

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.

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 - The ID of the new snapshot.
• csrsResponseStatus - -- | The response status code.

data CopySnapshotResponse

Contains the output of CopySnapshot.

See: copySnapshotResponse smart constructor.

Instances

Eq CopySnapshotResponse

Methods

(==) :: CopySnapshotResponse -> CopySnapshotResponse -> Bool

(/=) :: CopySnapshotResponse -> CopySnapshotResponse -> Bool

Data CopySnapshotResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CopySnapshotResponse -> c CopySnapshotResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CopySnapshotResponse

toConstr :: CopySnapshotResponse -> Constr

dataTypeOf :: CopySnapshotResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CopySnapshotResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CopySnapshotResponse)

gmapT :: (forall b. Data b => b -> b) -> CopySnapshotResponse -> CopySnapshotResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CopySnapshotResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CopySnapshotResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> CopySnapshotResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CopySnapshotResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CopySnapshotResponse -> m CopySnapshotResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CopySnapshotResponse -> m CopySnapshotResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CopySnapshotResponse -> m CopySnapshotResponse

Read CopySnapshotResponse

Methods

readsPrec :: Int -> ReadS CopySnapshotResponse

readList :: ReadS [CopySnapshotResponse]

readPrec :: ReadPrec CopySnapshotResponse

readListPrec :: ReadPrec [CopySnapshotResponse]

Show CopySnapshotResponse

Methods

showsPrec :: Int -> CopySnapshotResponse -> ShowS

show :: CopySnapshotResponse -> String

showList :: [CopySnapshotResponse] -> ShowS

Generic CopySnapshotResponse

Associated Types

type Rep CopySnapshotResponse :: * -> *

Methods

from :: CopySnapshotResponse -> Rep CopySnapshotResponse x

to :: Rep CopySnapshotResponse x -> CopySnapshotResponse

NFData CopySnapshotResponse

Methods

rnf :: CopySnapshotResponse -> ()

type Rep CopySnapshotResponse

type Rep CopySnapshotResponse = D1 * (MetaData "CopySnapshotResponse" "Network.AWS.EC2.CopySnapshot" "amazonka-ec2-1.6.0-Kkew7Kpgof6EYi20Z0WOzs" False) (C1 * (MetaCons "CopySnapshotResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_csrsSnapshotId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_csrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

csrsSnapshotId :: Lens' CopySnapshotResponse (Maybe Text)

The ID of the new snapshot.

csrsResponseStatus :: Lens' CopySnapshotResponse Int

• - | The response status code.