Network.AWS.RDS.CopyDBSnapshot

Copies the specified DB snapshot. The source DB snapshot must be in the "available" state.

You can copy a snapshot from one AWS Region to another. In that case, the AWS Region where you call the CopyDBSnapshot action is the destination AWS Region for the DB snapshot copy.

For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide.

Creating a Request

copyDBSnapshot

Arguments

:: Text

cdsSourceDBSnapshotIdentifier

-> Text

cdsTargetDBSnapshotIdentifier

-> CopyDBSnapshot

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

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

• cdsPreSignedURL - The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action in the source AWS Region that contains the source DB snapshot to copy. You must specify this parameter when you copy an encrypted DB snapshot from another AWS Region by using the Amazon RDS API. You can specify the --source-region option instead of this parameter when you copy an encrypted DB snapshot from another AWS Region by using the AWS CLI. The presigned URL must be a valid request for the CopyDBSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB snapshot to be copied. The presigned URL request must contain the following parameter values: * DestinationRegion - The AWS Region that the encrypted DB snapshot is copied to. This AWS Region is the same one where the CopyDBSnapshot action is called that contains this presigned URL. For example, if you copy an encrypted DB snapshot from the us-west-2 AWS Region to the us-east-1 AWS Region, then you call the CopyDBSnapshot action in the us-east-1 AWS Region and provide a presigned URL that contains a call to the CopyDBSnapshot action in the us-west-2 AWS Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 AWS Region. * KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB snapshot in the destination AWS Region. This is the same identifier for both the CopyDBSnapshot action that is called in the destination AWS Region, and the action contained in the presigned URL. * SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted 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 snapshot from the us-west-2 AWS Region, then your SourceDBSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-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 .
• cdsCopyTags - True to copy all tags from the source DB snapshot to the target DB snapshot, and otherwise false. The default is false.
• cdsKMSKeyId - The AWS KMS key ID for an encrypted DB 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 encrypted DB snapshot from your AWS account, you can specify a value for this parameter to encrypt the copy with a new KMS encryption key. If you don't specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot. If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for this parameter. If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted. If you copy an encrypted snapshot to a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.
• cdsOptionGroupName - The name of an option group to associate with the copy of the snapshot. Specify this option if you are copying a snapshot from one AWS Region to another, and your DB instance uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this option when copying across AWS Regions. For more information, see Option Group Considerations .
• cdsTags - Undocumented member.
• cdsSourceDBSnapshotIdentifier - The identifier for the source DB snapshot. If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier. For example, you might specify rds:mysql-instance1-snapshot-20130805 . If the source snapshot is in a different AWS Region than the copy, specify a valid DB snapshot ARN. For example, you might specify arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805 . If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot. If you are copying an encrypted snapshot this parameter must be in the ARN format for the source AWS Region, and must match the SourceDBSnapshotIdentifier in the PreSignedUrl parameter. Constraints: * Must specify a valid system snapshot in the "available" state. Example: rds:mydb-2012-04-02-00-01 Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805
• cdsTargetDBSnapshotIdentifier - The identifier for the copy of the snapshot. Constraints: * Cannot be null, empty, or blank * Must contain from 1 to 255 letters, numbers, or hyphens * First character must be a letter * Cannot end with a hyphen or contain two consecutive hyphens Example: my-db-snapshot

data CopyDBSnapshot

See: copyDBSnapshot smart constructor.

Instances

Eq CopyDBSnapshot

Methods

(==) :: CopyDBSnapshot -> CopyDBSnapshot -> Bool

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

Data CopyDBSnapshot

Methods

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

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

toConstr :: CopyDBSnapshot -> Constr

dataTypeOf :: CopyDBSnapshot -> DataType

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

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

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

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

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

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

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

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

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

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

Read CopyDBSnapshot

Methods

readsPrec :: Int -> ReadS CopyDBSnapshot

readList :: ReadS [CopyDBSnapshot]

readPrec :: ReadPrec CopyDBSnapshot

readListPrec :: ReadPrec [CopyDBSnapshot]

Show CopyDBSnapshot

Methods

showsPrec :: Int -> CopyDBSnapshot -> ShowS

show :: CopyDBSnapshot -> String

showList :: [CopyDBSnapshot] -> ShowS

Generic CopyDBSnapshot

Associated Types

type Rep CopyDBSnapshot :: * -> *

Methods

from :: CopyDBSnapshot -> Rep CopyDBSnapshot x

to :: Rep CopyDBSnapshot x -> CopyDBSnapshot

Hashable CopyDBSnapshot

Methods

hashWithSalt :: Int -> CopyDBSnapshot -> Int

hash :: CopyDBSnapshot -> Int

NFData CopyDBSnapshot

Methods

rnf :: CopyDBSnapshot -> ()

AWSRequest CopyDBSnapshot

Associated Types

type Rs CopyDBSnapshot :: *

Methods

request :: CopyDBSnapshot -> Request CopyDBSnapshot

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

ToHeaders CopyDBSnapshot

Methods

toHeaders :: CopyDBSnapshot -> [Header]

ToPath CopyDBSnapshot

Methods

toPath :: CopyDBSnapshot -> ByteString

ToQuery CopyDBSnapshot

Methods

toQuery :: CopyDBSnapshot -> QueryString

type Rep CopyDBSnapshot

type Rep CopyDBSnapshot = D1 * (MetaData "CopyDBSnapshot" "Network.AWS.RDS.CopyDBSnapshot" "amazonka-rds-1.6.0-1gpCa37cwlvAUzWljvprAs" False) (C1 * (MetaCons "CopyDBSnapshot'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cdsPreSignedURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cdsCopyTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_cdsKMSKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cdsOptionGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_cdsTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Tag])))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cdsSourceDBSnapshotIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_cdsTargetDBSnapshotIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))))

type Rs CopyDBSnapshot

type Rs CopyDBSnapshot = CopyDBSnapshotResponse

Request Lenses

cdsPreSignedURL :: Lens' CopyDBSnapshot (Maybe Text)

The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action in the source AWS Region that contains the source DB snapshot to copy. You must specify this parameter when you copy an encrypted DB snapshot from another AWS Region by using the Amazon RDS API. You can specify the --source-region option instead of this parameter when you copy an encrypted DB snapshot from another AWS Region by using the AWS CLI. The presigned URL must be a valid request for the CopyDBSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB snapshot to be copied. The presigned URL request must contain the following parameter values: * DestinationRegion - The AWS Region that the encrypted DB snapshot is copied to. This AWS Region is the same one where the CopyDBSnapshot action is called that contains this presigned URL. For example, if you copy an encrypted DB snapshot from the us-west-2 AWS Region to the us-east-1 AWS Region, then you call the CopyDBSnapshot action in the us-east-1 AWS Region and provide a presigned URL that contains a call to the CopyDBSnapshot action in the us-west-2 AWS Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 AWS Region. * KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB snapshot in the destination AWS Region. This is the same identifier for both the CopyDBSnapshot action that is called in the destination AWS Region, and the action contained in the presigned URL. * SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted 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 snapshot from the us-west-2 AWS Region, then your SourceDBSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-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 .

cdsCopyTags :: Lens' CopyDBSnapshot (Maybe Bool)

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

cdsKMSKeyId :: Lens' CopyDBSnapshot (Maybe Text)

The AWS KMS key ID for an encrypted DB 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 encrypted DB snapshot from your AWS account, you can specify a value for this parameter to encrypt the copy with a new KMS encryption key. If you don't specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot. If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for this parameter. If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted. If you copy an encrypted snapshot to a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.

cdsOptionGroupName :: Lens' CopyDBSnapshot (Maybe Text)

The name of an option group to associate with the copy of the snapshot. Specify this option if you are copying a snapshot from one AWS Region to another, and your DB instance uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this option when copying across AWS Regions. For more information, see Option Group Considerations .

cdsTags :: Lens' CopyDBSnapshot [Tag]

Undocumented member.

cdsSourceDBSnapshotIdentifier :: Lens' CopyDBSnapshot Text

The identifier for the source DB snapshot. If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier. For example, you might specify rds:mysql-instance1-snapshot-20130805 . If the source snapshot is in a different AWS Region than the copy, specify a valid DB snapshot ARN. For example, you might specify arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805 . If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot. If you are copying an encrypted snapshot this parameter must be in the ARN format for the source AWS Region, and must match the SourceDBSnapshotIdentifier in the PreSignedUrl parameter. Constraints: * Must specify a valid system snapshot in the "available" state. Example: rds:mydb-2012-04-02-00-01 Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805

cdsTargetDBSnapshotIdentifier :: Lens' CopyDBSnapshot Text

The identifier for the copy of the snapshot. Constraints: * Cannot be null, empty, or blank * Must contain from 1 to 255 letters, numbers, or hyphens * First character must be a letter * Cannot end with a hyphen or contain two consecutive hyphens Example: my-db-snapshot

Destructuring the Response

copyDBSnapshotResponse

Arguments

:: Int

cdsrsResponseStatus

-> CopyDBSnapshotResponse

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

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

• cdsrsDBSnapshot - Undocumented member.
• cdsrsResponseStatus - -- | The response status code.

data CopyDBSnapshotResponse

See: copyDBSnapshotResponse smart constructor.

Instances

Eq CopyDBSnapshotResponse

Methods

(==) :: CopyDBSnapshotResponse -> CopyDBSnapshotResponse -> Bool

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

Data CopyDBSnapshotResponse

Methods

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

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

toConstr :: CopyDBSnapshotResponse -> Constr

dataTypeOf :: CopyDBSnapshotResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read CopyDBSnapshotResponse

Methods

readsPrec :: Int -> ReadS CopyDBSnapshotResponse

readList :: ReadS [CopyDBSnapshotResponse]

readPrec :: ReadPrec CopyDBSnapshotResponse

readListPrec :: ReadPrec [CopyDBSnapshotResponse]

Show CopyDBSnapshotResponse

Methods

showsPrec :: Int -> CopyDBSnapshotResponse -> ShowS

show :: CopyDBSnapshotResponse -> String

showList :: [CopyDBSnapshotResponse] -> ShowS

Generic CopyDBSnapshotResponse

Associated Types

type Rep CopyDBSnapshotResponse :: * -> *

Methods

from :: CopyDBSnapshotResponse -> Rep CopyDBSnapshotResponse x

to :: Rep CopyDBSnapshotResponse x -> CopyDBSnapshotResponse

NFData CopyDBSnapshotResponse

Methods

rnf :: CopyDBSnapshotResponse -> ()

type Rep CopyDBSnapshotResponse

type Rep CopyDBSnapshotResponse = D1 * (MetaData "CopyDBSnapshotResponse" "Network.AWS.RDS.CopyDBSnapshot" "amazonka-rds-1.6.0-1gpCa37cwlvAUzWljvprAs" False) (C1 * (MetaCons "CopyDBSnapshotResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_cdsrsDBSnapshot") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe DBSnapshot))) (S1 * (MetaSel (Just Symbol "_cdsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

cdsrsDBSnapshot :: Lens' CopyDBSnapshotResponse (Maybe DBSnapshot)

Undocumented member.

cdsrsResponseStatus :: Lens' CopyDBSnapshotResponse Int

• - | The response status code.