Network.AWS.RDS.CopyDBClusterSnapshot

Copies a snapshot of a DB cluster.

To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.

You can copy an encrypted DB cluster snapshot from another AWS Region. In that case, the AWS Region where you call the CopyDBClusterSnapshot action is the destination AWS Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another AWS Region, you must provide the following values:

• KmsKeyId - The AWS Key Management System (KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region.
• PreSignedUrl - A URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot action to be called in the source AWS Region where the DB cluster snapshot is copied from. The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied.

The pre-signed URL request must contain the following parameter values:

• KmsKeyId - The KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination AWS Region, and the action contained in the pre-signed URL.
• DestinationRegion - The name of the AWS Region that the DB cluster snapshot will be created in.
• SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115 .

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process .

• TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination AWS Region.
• SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source AWS Region and is the same value as the SourceDBClusterSnapshotIdentifier in the pre-signed URL.

To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in "copying" status.

For more information on copying encrypted DB cluster snapshots from one AWS Region to another, see Copying a DB Cluster Snapshot in the Same Account, Either in the Same Region or Across Regions in the Amazon RDS User Guide.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

Creating a Request

copyDBClusterSnapshot

Arguments

:: Text

cdbcsSourceDBClusterSnapshotIdentifier

-> Text

cdbcsTargetDBClusterSnapshotIdentifier

-> CopyDBClusterSnapshot

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

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

• cdbcsPreSignedURL - The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the AWS Region that contains the source DB cluster snapshot to copy. The PreSignedUrl parameter must be used when copying an encrypted DB cluster snapshot from another AWS Region. The pre-signed URL must be a valid request for the CopyDBSClusterSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values: * KmsKeyId - The KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination AWS Region, and the action contained in the pre-signed URL. * DestinationRegion - The name of the AWS Region that the DB cluster snapshot will be created in. * SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115 . To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process .
• cdbcsCopyTags - True to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot; otherwise false. The default is false.
• cdbcsKMSKeyId - The AWS KMS key ID for an encrypted DB cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key. If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, Amazon RDS encrypts the target DB cluster snapshot using the specified KMS encryption key. If you copy an encrypted DB cluster snapshot from your AWS account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId , then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot. If you copy an encrypted DB cluster snapshot that is shared from another AWS account, then you must specify a value for KmsKeyId . To copy an encrypted DB cluster snapshot to another AWS Region, you must set KmsKeyId to the KMS key ID you want to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you cannot use encryption keys from one AWS Region in another AWS Region.
• cdbcsTags - Undocumented member.
• cdbcsSourceDBClusterSnapshotIdentifier - The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive. You cannot copy an encrypted, shared DB cluster snapshot from one AWS Region to another. Constraints: * Must specify a valid system snapshot in the "available" state. * If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier. * If the source snapshot is in a different AWS Region than the copy, specify a valid DB cluster snapshot ARN. For more information, go to Copying a DB Snapshot or DB Cluster Snapshot . Example: my-cluster-snapshot1
• cdbcsTargetDBClusterSnapshotIdentifier - The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter is not case-sensitive. Constraints: * Must contain from 1 to 63 letters, numbers, or hyphens. * First character must be a letter. * Cannot end with a hyphen or contain two consecutive hyphens. Example: my-cluster-snapshot2

data CopyDBClusterSnapshot

See: copyDBClusterSnapshot smart constructor.

Instances

Eq CopyDBClusterSnapshot

Methods

(==) :: CopyDBClusterSnapshot -> CopyDBClusterSnapshot -> Bool

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

Data CopyDBClusterSnapshot

Methods

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

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

toConstr :: CopyDBClusterSnapshot -> Constr

dataTypeOf :: CopyDBClusterSnapshot -> DataType

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

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

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

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

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

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

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

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

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

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

Read CopyDBClusterSnapshot

Methods

readsPrec :: Int -> ReadS CopyDBClusterSnapshot

readList :: ReadS [CopyDBClusterSnapshot]

readPrec :: ReadPrec CopyDBClusterSnapshot

readListPrec :: ReadPrec [CopyDBClusterSnapshot]

Show CopyDBClusterSnapshot

Methods

showsPrec :: Int -> CopyDBClusterSnapshot -> ShowS

show :: CopyDBClusterSnapshot -> String

showList :: [CopyDBClusterSnapshot] -> ShowS

Generic CopyDBClusterSnapshot

Associated Types

type Rep CopyDBClusterSnapshot :: * -> *

Methods

from :: CopyDBClusterSnapshot -> Rep CopyDBClusterSnapshot x

to :: Rep CopyDBClusterSnapshot x -> CopyDBClusterSnapshot

Hashable CopyDBClusterSnapshot

Methods

hashWithSalt :: Int -> CopyDBClusterSnapshot -> Int

hash :: CopyDBClusterSnapshot -> Int

NFData CopyDBClusterSnapshot

Methods

rnf :: CopyDBClusterSnapshot -> ()

AWSRequest CopyDBClusterSnapshot

Associated Types

type Rs CopyDBClusterSnapshot :: *

Methods

request :: CopyDBClusterSnapshot -> Request CopyDBClusterSnapshot

response :: MonadResource m => Logger -> Service -> Proxy * CopyDBClusterSnapshot -> ClientResponse -> m (Response CopyDBClusterSnapshot)

ToQuery CopyDBClusterSnapshot

Methods

toQuery :: CopyDBClusterSnapshot -> QueryString

ToPath CopyDBClusterSnapshot

Methods

toPath :: CopyDBClusterSnapshot -> ByteString

ToHeaders CopyDBClusterSnapshot

Methods

toHeaders :: CopyDBClusterSnapshot -> [Header]

type Rep CopyDBClusterSnapshot

type Rep CopyDBClusterSnapshot = D1 (MetaData "CopyDBClusterSnapshot" "Network.AWS.RDS.CopyDBClusterSnapshot" "amazonka-rds-1.5.0-4pv5DetELOaBXetw2fB1GM" False) (C1 (MetaCons "CopyDBClusterSnapshot'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cdbcsPreSignedURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_cdbcsCopyTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_cdbcsKMSKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_cdbcsTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Tag]))) ((:*:) (S1 (MetaSel (Just Symbol "_cdbcsSourceDBClusterSnapshotIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_cdbcsTargetDBClusterSnapshotIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

type Rs CopyDBClusterSnapshot

type Rs CopyDBClusterSnapshot = CopyDBClusterSnapshotResponse

Request Lenses

cdbcsPreSignedURL :: Lens' CopyDBClusterSnapshot (Maybe Text)

The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the AWS Region that contains the source DB cluster snapshot to copy. The PreSignedUrl parameter must be used when copying an encrypted DB cluster snapshot from another AWS Region. The pre-signed URL must be a valid request for the CopyDBSClusterSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values: * KmsKeyId - The KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination AWS Region, and the action contained in the pre-signed URL. * DestinationRegion - The name of the AWS Region that the DB cluster snapshot will be created in. * SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115 . To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process .

cdbcsCopyTags :: Lens' CopyDBClusterSnapshot (Maybe Bool)

True to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot; otherwise false. The default is false.

cdbcsKMSKeyId :: Lens' CopyDBClusterSnapshot (Maybe Text)

The AWS KMS key ID for an encrypted DB cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key. If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, Amazon RDS encrypts the target DB cluster snapshot using the specified KMS encryption key. If you copy an encrypted DB cluster snapshot from your AWS account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId , then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot. If you copy an encrypted DB cluster snapshot that is shared from another AWS account, then you must specify a value for KmsKeyId . To copy an encrypted DB cluster snapshot to another AWS Region, you must set KmsKeyId to the KMS key ID you want to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you cannot use encryption keys from one AWS Region in another AWS Region.

cdbcsTags :: Lens' CopyDBClusterSnapshot [Tag]

Undocumented member.

cdbcsSourceDBClusterSnapshotIdentifier :: Lens' CopyDBClusterSnapshot Text

The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive. You cannot copy an encrypted, shared DB cluster snapshot from one AWS Region to another. Constraints: * Must specify a valid system snapshot in the "available" state. * If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier. * If the source snapshot is in a different AWS Region than the copy, specify a valid DB cluster snapshot ARN. For more information, go to Copying a DB Snapshot or DB Cluster Snapshot . Example: my-cluster-snapshot1

cdbcsTargetDBClusterSnapshotIdentifier :: Lens' CopyDBClusterSnapshot Text

The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter is not case-sensitive. Constraints: * Must contain from 1 to 63 letters, numbers, or hyphens. * First character must be a letter. * Cannot end with a hyphen or contain two consecutive hyphens. Example: my-cluster-snapshot2

Destructuring the Response

copyDBClusterSnapshotResponse

Arguments

:: Int

cdcsrsResponseStatus

-> CopyDBClusterSnapshotResponse

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

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

• cdcsrsDBClusterSnapshot - Undocumented member.
• cdcsrsResponseStatus - -- | The response status code.

data CopyDBClusterSnapshotResponse

See: copyDBClusterSnapshotResponse smart constructor.

Instances

Eq CopyDBClusterSnapshotResponse

Methods

(==) :: CopyDBClusterSnapshotResponse -> CopyDBClusterSnapshotResponse -> Bool

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

Data CopyDBClusterSnapshotResponse

Methods

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

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

toConstr :: CopyDBClusterSnapshotResponse -> Constr

dataTypeOf :: CopyDBClusterSnapshotResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read CopyDBClusterSnapshotResponse

Methods

readsPrec :: Int -> ReadS CopyDBClusterSnapshotResponse

readList :: ReadS [CopyDBClusterSnapshotResponse]

readPrec :: ReadPrec CopyDBClusterSnapshotResponse

readListPrec :: ReadPrec [CopyDBClusterSnapshotResponse]

Show CopyDBClusterSnapshotResponse

Methods

showsPrec :: Int -> CopyDBClusterSnapshotResponse -> ShowS

show :: CopyDBClusterSnapshotResponse -> String

showList :: [CopyDBClusterSnapshotResponse] -> ShowS

Generic CopyDBClusterSnapshotResponse

Associated Types

type Rep CopyDBClusterSnapshotResponse :: * -> *

Methods

from :: CopyDBClusterSnapshotResponse -> Rep CopyDBClusterSnapshotResponse x

to :: Rep CopyDBClusterSnapshotResponse x -> CopyDBClusterSnapshotResponse

NFData CopyDBClusterSnapshotResponse

Methods

rnf :: CopyDBClusterSnapshotResponse -> ()

type Rep CopyDBClusterSnapshotResponse

type Rep CopyDBClusterSnapshotResponse = D1 (MetaData "CopyDBClusterSnapshotResponse" "Network.AWS.RDS.CopyDBClusterSnapshot" "amazonka-rds-1.5.0-4pv5DetELOaBXetw2fB1GM" False) (C1 (MetaCons "CopyDBClusterSnapshotResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_cdcsrsDBClusterSnapshot") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DBClusterSnapshot))) (S1 (MetaSel (Just Symbol "_cdcsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

cdcsrsDBClusterSnapshot :: Lens' CopyDBClusterSnapshotResponse (Maybe DBClusterSnapshot)

Undocumented member.

cdcsrsResponseStatus :: Lens' CopyDBClusterSnapshotResponse Int

• - | The response status code.