Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.RDS.CopyDBSnapshot

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

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

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

Synopsis

data CopyDBSnapshot = CopyDBSnapshot' {
- targetCustomAvailabilityZone :: Maybe Text
- preSignedUrl :: Maybe Text
- copyTags :: Maybe Bool
- destinationRegion :: Maybe Text
- kmsKeyId :: Maybe Text
- optionGroupName :: Maybe Text
- tags :: Maybe [Tag]
- sourceDBSnapshotIdentifier :: Text
- targetDBSnapshotIdentifier :: Text
}
newCopyDBSnapshot :: Text -> Text -> CopyDBSnapshot
copyDBSnapshot_targetCustomAvailabilityZone :: Lens' CopyDBSnapshot (Maybe Text)
copyDBSnapshot_preSignedUrl :: Lens' CopyDBSnapshot (Maybe Text)
copyDBSnapshot_copyTags :: Lens' CopyDBSnapshot (Maybe Bool)
copyDBSnapshot_destinationRegion :: Lens' CopyDBSnapshot (Maybe Text)
copyDBSnapshot_kmsKeyId :: Lens' CopyDBSnapshot (Maybe Text)
copyDBSnapshot_optionGroupName :: Lens' CopyDBSnapshot (Maybe Text)
copyDBSnapshot_tags :: Lens' CopyDBSnapshot (Maybe [Tag])
copyDBSnapshot_sourceDBSnapshotIdentifier :: Lens' CopyDBSnapshot Text
copyDBSnapshot_targetDBSnapshotIdentifier :: Lens' CopyDBSnapshot Text
data CopyDBSnapshotResponse = CopyDBSnapshotResponse' {
- dbSnapshot :: Maybe DBSnapshot
- httpStatus :: Int
}
newCopyDBSnapshotResponse :: Int -> CopyDBSnapshotResponse
copyDBSnapshotResponse_dbSnapshot :: Lens' CopyDBSnapshotResponse (Maybe DBSnapshot)
copyDBSnapshotResponse_httpStatus :: Lens' CopyDBSnapshotResponse Int

Creating a Request

data CopyDBSnapshot Source #

See: newCopyDBSnapshot smart constructor.

Constructors

CopyDBSnapshot'

Fields

targetCustomAvailabilityZone :: Maybe Text
The external custom Availability Zone (CAZ) identifier for the target CAZ.
Example: rds-caz-aiqhTgQv.
preSignedUrl :: Maybe Text
The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action in the source Amazon Web Services Region that contains the source DB snapshot to copy.
You must specify this parameter when you copy an encrypted DB snapshot from another Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are copying an encrypted DB snapshot in the same Amazon Web Services Region.
The presigned URL must be a valid request for the CopyDBSnapshot API action that can be executed in the source Amazon Web Services Region that contains the encrypted DB snapshot to be copied. The presigned URL request must contain the following parameter values:
- DestinationRegion - The Amazon Web Services Region that the encrypted DB snapshot is copied to. This Amazon Web Services 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 Amazon Web Services Region to the us-east-1 Amazon Web Services Region, then you call the CopyDBSnapshot action in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CopyDBSnapshot action in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region.
- KmsKeyId - The Amazon Web Services KMS key identifier for the customer master key (CMK) to use to encrypt the copy of the DB snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBSnapshot action that is called in the destination Amazon Web Services 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 Amazon Web Services Region. For example, if you are copying an encrypted DB snapshot from the us-west-2 Amazon Web Services 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 (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region.
copyTags :: Maybe Bool
A value that indicates whether to copy all tags from the source DB snapshot to the target DB snapshot. By default, tags are not copied.
destinationRegion :: Maybe Text
Pseudo-parameter used when populating the PreSignedUrl of a cross-region CopyDBSnapshot request. To replicate from region SRC to region DST, send a request to region DST. In that request, pass a PreSignedUrl for region SRC with DestinationRegion set to region DST.
kmsKeyId :: Maybe Text
The Amazon Web Services KMS key identifier for an encrypted DB snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).
If you copy an encrypted DB snapshot from your Amazon Web Services account, you can specify a value for this parameter to encrypt the copy with a new Amazon Web Services KMS CMK. If you don't specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same Amazon Web Services KMS key as the source DB snapshot.
If you copy an encrypted DB snapshot that is shared from another Amazon Web Services 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 Amazon Web Services Region, then you must specify a Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. Amazon Web Services KMS CMKs are specific to the Amazon Web Services Region that they are created in, and you can't use CMKs from one Amazon Web Services Region in another Amazon Web Services Region.
optionGroupName :: 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 Amazon Web Services 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 Amazon Web Services Regions. For more information, see Option group considerations in the Amazon RDS User Guide.
tags :: Maybe [Tag]
sourceDBSnapshotIdentifier :: Text
The identifier for the source DB snapshot.
If the source snapshot is in the same Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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
targetDBSnapshotIdentifier :: Text
The identifier for the copy of the snapshot.
Constraints:
- Can't be null, empty, or blank
- Must contain from 1 to 255 letters, numbers, or hyphens
- First character must be a letter
- Can't end with a hyphen or contain two consecutive hyphens
Example: my-db-snapshot

Instances

Instances details

Eq CopyDBSnapshot Source #
Instance details Defined in Amazonka.RDS.CopyDBSnapshot Methods (==) :: CopyDBSnapshot -> CopyDBSnapshot -> Bool # (/=) :: CopyDBSnapshot -> CopyDBSnapshot -> Bool #
Read CopyDBSnapshot Source #
Instance details Defined in Amazonka.RDS.CopyDBSnapshot Methods readsPrec :: Int -> ReadS CopyDBSnapshot # readList :: ReadS [CopyDBSnapshot] # readPrec :: ReadPrec CopyDBSnapshot # readListPrec :: ReadPrec [CopyDBSnapshot] #
Show CopyDBSnapshot Source #
Instance details Defined in Amazonka.RDS.CopyDBSnapshot Methods showsPrec :: Int -> CopyDBSnapshot -> ShowS # show :: CopyDBSnapshot -> String # showList :: [CopyDBSnapshot] -> ShowS #
Generic CopyDBSnapshot Source #
Instance details Defined in Amazonka.RDS.CopyDBSnapshot Associated Types type Rep CopyDBSnapshot :: Type -> Type # Methods from :: CopyDBSnapshot -> Rep CopyDBSnapshot x # to :: Rep CopyDBSnapshot x -> CopyDBSnapshot #
NFData CopyDBSnapshot Source #
Instance details Defined in Amazonka.RDS.CopyDBSnapshot Methods rnf :: CopyDBSnapshot -> () #
Hashable CopyDBSnapshot Source #
Instance details Defined in Amazonka.RDS.CopyDBSnapshot Methods hashWithSalt :: Int -> CopyDBSnapshot -> Int # hash :: CopyDBSnapshot -> Int #
AWSRequest CopyDBSnapshot Source #
Instance details Defined in Amazonka.RDS.CopyDBSnapshot Associated Types type AWSResponse CopyDBSnapshot # Methods request :: CopyDBSnapshot -> Request CopyDBSnapshot # response :: MonadResource m => Logger -> Service -> Proxy CopyDBSnapshot -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CopyDBSnapshot))) #
ToHeaders CopyDBSnapshot Source #
Instance details Defined in Amazonka.RDS.CopyDBSnapshot Methods toHeaders :: CopyDBSnapshot -> [Header] #
ToPath CopyDBSnapshot Source #
Instance details Defined in Amazonka.RDS.CopyDBSnapshot Methods toPath :: CopyDBSnapshot -> ByteString #
ToQuery CopyDBSnapshot Source #
Instance details Defined in Amazonka.RDS.CopyDBSnapshot Methods toQuery :: CopyDBSnapshot -> QueryString #
type Rep CopyDBSnapshot Source #
Instance details Defined in Amazonka.RDS.CopyDBSnapshot type Rep CopyDBSnapshot = D1 ('MetaData "CopyDBSnapshot" "Amazonka.RDS.CopyDBSnapshot" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "CopyDBSnapshot'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "targetCustomAvailabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "preSignedUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "copyTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "destinationRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "optionGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: (S1 ('MetaSel ('Just "sourceDBSnapshotIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "targetDBSnapshotIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse CopyDBSnapshot Source #
Instance details Defined in Amazonka.RDS.CopyDBSnapshot type AWSResponse CopyDBSnapshot = CopyDBSnapshotResponse

newCopyDBSnapshot Source #

Arguments

:: Text	`$sel:sourceDBSnapshotIdentifier:CopyDBSnapshot'`
-> Text	`$sel:targetDBSnapshotIdentifier:CopyDBSnapshot'`
-> CopyDBSnapshot

Create a value of CopyDBSnapshot 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:

$sel:targetCustomAvailabilityZone:CopyDBSnapshot', copyDBSnapshot_targetCustomAvailabilityZone - The external custom Availability Zone (CAZ) identifier for the target CAZ.

Example: rds-caz-aiqhTgQv.

$sel:preSignedUrl:CopyDBSnapshot', copyDBSnapshot_preSignedUrl - The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action in the source Amazon Web Services Region that contains the source DB snapshot to copy.

You must specify this parameter when you copy an encrypted DB snapshot from another Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are copying an encrypted DB snapshot in the same Amazon Web Services Region.

The presigned URL must be a valid request for the CopyDBSnapshot API action that can be executed in the source Amazon Web Services Region that contains the encrypted DB snapshot to be copied. The presigned URL request must contain the following parameter values:

DestinationRegion - The Amazon Web Services Region that the encrypted DB snapshot is copied to. This Amazon Web Services 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 Amazon Web Services Region to the us-east-1 Amazon Web Services Region, then you call the CopyDBSnapshot action in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CopyDBSnapshot action in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region.
KmsKeyId - The Amazon Web Services KMS key identifier for the customer master key (CMK) to use to encrypt the copy of the DB snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBSnapshot action that is called in the destination Amazon Web Services 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 Amazon Web Services Region. For example, if you are copying an encrypted DB snapshot from the us-west-2 Amazon Web Services 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 (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region.

$sel:copyTags:CopyDBSnapshot', copyDBSnapshot_copyTags - A value that indicates whether to copy all tags from the source DB snapshot to the target DB snapshot. By default, tags are not copied.

$sel:destinationRegion:CopyDBSnapshot', copyDBSnapshot_destinationRegion - Pseudo-parameter used when populating the PreSignedUrl of a cross-region CopyDBSnapshot request. To replicate from region SRC to region DST, send a request to region DST. In that request, pass a PreSignedUrl for region SRC with DestinationRegion set to region DST.

$sel:kmsKeyId:CopyDBSnapshot', copyDBSnapshot_kmsKeyId - The Amazon Web Services KMS key identifier for an encrypted DB snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).

If you copy an encrypted DB snapshot from your Amazon Web Services account, you can specify a value for this parameter to encrypt the copy with a new Amazon Web Services KMS CMK. If you don't specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same Amazon Web Services KMS key as the source DB snapshot.

If you copy an encrypted DB snapshot that is shared from another Amazon Web Services 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 Amazon Web Services Region, then you must specify a Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. Amazon Web Services KMS CMKs are specific to the Amazon Web Services Region that they are created in, and you can't use CMKs from one Amazon Web Services Region in another Amazon Web Services Region.

$sel:optionGroupName:CopyDBSnapshot', copyDBSnapshot_optionGroupName - 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 Amazon Web Services 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 Amazon Web Services Regions. For more information, see Option group considerations in the Amazon RDS User Guide.

$sel:tags:CopyDBSnapshot', copyDBSnapshot_tags - Undocumented member.

$sel:sourceDBSnapshotIdentifier:CopyDBSnapshot', copyDBSnapshot_sourceDBSnapshotIdentifier - The identifier for the source DB snapshot.

If the source snapshot is in the same Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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

$sel:targetDBSnapshotIdentifier:CopyDBSnapshot', copyDBSnapshot_targetDBSnapshotIdentifier - The identifier for the copy of the snapshot.

Constraints:

Can't be null, empty, or blank
Must contain from 1 to 255 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens

Example: my-db-snapshot

Request Lenses

copyDBSnapshot_targetCustomAvailabilityZone :: Lens' CopyDBSnapshot (Maybe Text) Source #

The external custom Availability Zone (CAZ) identifier for the target CAZ.

Example: rds-caz-aiqhTgQv.

copyDBSnapshot_preSignedUrl :: Lens' CopyDBSnapshot (Maybe Text) Source #

The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action in the source Amazon Web Services Region that contains the source DB snapshot to copy.

You must specify this parameter when you copy an encrypted DB snapshot from another Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are copying an encrypted DB snapshot in the same Amazon Web Services Region.

The presigned URL must be a valid request for the CopyDBSnapshot API action that can be executed in the source Amazon Web Services Region that contains the encrypted DB snapshot to be copied. The presigned URL request must contain the following parameter values:

DestinationRegion - The Amazon Web Services Region that the encrypted DB snapshot is copied to. This Amazon Web Services 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 Amazon Web Services Region to the us-east-1 Amazon Web Services Region, then you call the CopyDBSnapshot action in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CopyDBSnapshot action in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region.
KmsKeyId - The Amazon Web Services KMS key identifier for the customer master key (CMK) to use to encrypt the copy of the DB snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBSnapshot action that is called in the destination Amazon Web Services 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 Amazon Web Services Region. For example, if you are copying an encrypted DB snapshot from the us-west-2 Amazon Web Services 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 (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region.

copyDBSnapshot_copyTags :: Lens' CopyDBSnapshot (Maybe Bool) Source #

A value that indicates whether to copy all tags from the source DB snapshot to the target DB snapshot. By default, tags are not copied.

copyDBSnapshot_destinationRegion :: Lens' CopyDBSnapshot (Maybe Text) Source #

Pseudo-parameter used when populating the PreSignedUrl of a cross-region CopyDBSnapshot request. To replicate from region SRC to region DST, send a request to region DST. In that request, pass a PreSignedUrl for region SRC with DestinationRegion set to region DST.

copyDBSnapshot_kmsKeyId :: Lens' CopyDBSnapshot (Maybe Text) Source #

The Amazon Web Services KMS key identifier for an encrypted DB snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).

If you copy an encrypted DB snapshot from your Amazon Web Services account, you can specify a value for this parameter to encrypt the copy with a new Amazon Web Services KMS CMK. If you don't specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same Amazon Web Services KMS key as the source DB snapshot.

If you copy an encrypted DB snapshot that is shared from another Amazon Web Services 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 Amazon Web Services Region, then you must specify a Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. Amazon Web Services KMS CMKs are specific to the Amazon Web Services Region that they are created in, and you can't use CMKs from one Amazon Web Services Region in another Amazon Web Services Region.

copyDBSnapshot_optionGroupName :: Lens' CopyDBSnapshot (Maybe Text) Source #

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 Amazon Web Services 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 Amazon Web Services Regions. For more information, see Option group considerations in the Amazon RDS User Guide.

copyDBSnapshot_tags :: Lens' CopyDBSnapshot (Maybe [Tag]) Source #

Undocumented member.

copyDBSnapshot_sourceDBSnapshotIdentifier :: Lens' CopyDBSnapshot Text Source #

The identifier for the source DB snapshot.

If the source snapshot is in the same Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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

copyDBSnapshot_targetDBSnapshotIdentifier :: Lens' CopyDBSnapshot Text Source #

The identifier for the copy of the snapshot.

Constraints:

Can't be null, empty, or blank
Must contain from 1 to 255 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens

Example: my-db-snapshot

Destructuring the Response

data CopyDBSnapshotResponse Source #

See: newCopyDBSnapshotResponse smart constructor.

Constructors

CopyDBSnapshotResponse'
Fields dbSnapshot :: Maybe DBSnapshot httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CopyDBSnapshotResponse Source #
Instance details Defined in Amazonka.RDS.CopyDBSnapshot Methods (==) :: CopyDBSnapshotResponse -> CopyDBSnapshotResponse -> Bool # (/=) :: CopyDBSnapshotResponse -> CopyDBSnapshotResponse -> Bool #
Read CopyDBSnapshotResponse Source #
Instance details Defined in Amazonka.RDS.CopyDBSnapshot Methods readsPrec :: Int -> ReadS CopyDBSnapshotResponse # readList :: ReadS [CopyDBSnapshotResponse] # readPrec :: ReadPrec CopyDBSnapshotResponse # readListPrec :: ReadPrec [CopyDBSnapshotResponse] #
Show CopyDBSnapshotResponse Source #
Instance details Defined in Amazonka.RDS.CopyDBSnapshot Methods showsPrec :: Int -> CopyDBSnapshotResponse -> ShowS # show :: CopyDBSnapshotResponse -> String # showList :: [CopyDBSnapshotResponse] -> ShowS #
Generic CopyDBSnapshotResponse Source #
Instance details Defined in Amazonka.RDS.CopyDBSnapshot Associated Types type Rep CopyDBSnapshotResponse :: Type -> Type # Methods from :: CopyDBSnapshotResponse -> Rep CopyDBSnapshotResponse x # to :: Rep CopyDBSnapshotResponse x -> CopyDBSnapshotResponse #
NFData CopyDBSnapshotResponse Source #
Instance details Defined in Amazonka.RDS.CopyDBSnapshot Methods rnf :: CopyDBSnapshotResponse -> () #
type Rep CopyDBSnapshotResponse Source #
Instance details Defined in Amazonka.RDS.CopyDBSnapshot type Rep CopyDBSnapshotResponse = D1 ('MetaData "CopyDBSnapshotResponse" "Amazonka.RDS.CopyDBSnapshot" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "CopyDBSnapshotResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbSnapshot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBSnapshot)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCopyDBSnapshotResponse Source #

Arguments

:: Int	`$sel:httpStatus:CopyDBSnapshotResponse'`
-> CopyDBSnapshotResponse

Create a value of CopyDBSnapshotResponse 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:

$sel:dbSnapshot:CopyDBSnapshotResponse', copyDBSnapshotResponse_dbSnapshot - Undocumented member.

$sel:httpStatus:CopyDBSnapshotResponse', copyDBSnapshotResponse_httpStatus - The response's http status code.

Response Lenses

copyDBSnapshotResponse_dbSnapshot :: Lens' CopyDBSnapshotResponse (Maybe DBSnapshot) Source #

Undocumented member.

copyDBSnapshotResponse_httpStatus :: Lens' CopyDBSnapshotResponse Int Source #

The response's http status code.