Copyright | (c) 2013-2017 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 |
Language | Haskell2010 |
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.
You cannot copy an encrypted, shared DB snapshot from one AWS Region to another.
For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide.
- copyDBSnapshot :: Text -> Text -> CopyDBSnapshot
- data CopyDBSnapshot
- cdsPreSignedURL :: Lens' CopyDBSnapshot (Maybe Text)
- cdsCopyTags :: Lens' CopyDBSnapshot (Maybe Bool)
- cdsKMSKeyId :: Lens' CopyDBSnapshot (Maybe Text)
- cdsOptionGroupName :: Lens' CopyDBSnapshot (Maybe Text)
- cdsTags :: Lens' CopyDBSnapshot [Tag]
- cdsSourceDBSnapshotIdentifier :: Lens' CopyDBSnapshot Text
- cdsTargetDBSnapshotIdentifier :: Lens' CopyDBSnapshot Text
- copyDBSnapshotResponse :: Int -> CopyDBSnapshotResponse
- data CopyDBSnapshotResponse
- cdsrsDBSnapshot :: Lens' CopyDBSnapshotResponse (Maybe DBSnapshot)
- cdsrsResponseStatus :: Lens' CopyDBSnapshotResponse Int
Creating a Request
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 theCopyDBSnapshot
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 theCopyDBSnapshot
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 theCopyDBSnapshot
action is called that contains this presigned URL. For example, if you copy an encrypted DB snapshot from the us-west-2 region to the us-east-1 region, then you call theCopyDBSnapshot
action in the us-east-1 region and provide a presigned URL that contains a call to theCopyDBSnapshot
action in the us-west-2 region. For this example, theDestinationRegion
in the presigned URL must be set to the us-east-1 region. *KmsKeyId
- The 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 theCopyDBSnapshot
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 region, then yourSourceDBSnapshotIdentifier
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; 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 cannot 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 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 specifyrds: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 specifyarn: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 theSourceDBSnapshotIdentifier
in thePreSignedUrl
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 Source #
See: copyDBSnapshot
smart constructor.
Request Lenses
cdsPreSignedURL :: Lens' CopyDBSnapshot (Maybe Text) Source #
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 region to the us-east-1 region, then you call the CopyDBSnapshot
action in the us-east-1 region and provide a presigned URL that contains a call to the CopyDBSnapshot
action in the us-west-2 region. For this example, the DestinationRegion
in the presigned URL must be set to the us-east-1 region. * KmsKeyId
- The 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 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) Source #
True to copy all tags from the source DB snapshot to the target DB snapshot; otherwise false. The default is false.
cdsKMSKeyId :: Lens' CopyDBSnapshot (Maybe Text) Source #
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 cannot use encryption keys from one AWS Region in another AWS Region.
cdsOptionGroupName :: 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 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 regions. For more information, see Option Group Considerations .
cdsSourceDBSnapshotIdentifier :: Lens' CopyDBSnapshot Text Source #
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 Source #
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 Source #
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 Source #
See: copyDBSnapshotResponse
smart constructor.
Response Lenses
cdsrsDBSnapshot :: Lens' CopyDBSnapshotResponse (Maybe DBSnapshot) Source #
Undocumented member.
cdsrsResponseStatus :: Lens' CopyDBSnapshotResponse Int Source #
- - | The response status code.