| Copyright | (c) 2013-2016 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.RDS.CopyDBSnapshot
Description
Copies the specified DB Snapshot. The source DB snapshot must be in the "available" state.
If you are copying from a shared manual DB snapshot, the
SourceDBSnapshotIdentifier must be the ARN of the shared DB snapshot.
- copyDBSnapshot :: Text -> Text -> CopyDBSnapshot
- data CopyDBSnapshot
- cdsCopyTags :: Lens' CopyDBSnapshot (Maybe Bool)
- cdsKMSKeyId :: 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:
data CopyDBSnapshot Source
See: copyDBSnapshot smart constructor.
Instances
Request Lenses
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 Key Management Service (AWS KMS) key identifier for an encrypted DB snapshot. The KMS key identifier is the Amazon Resource Name (ARN) or the KMS key alias for the KMS encryption key.
If you copy an unencrypted DB snapshot and specify a value for the
KmsKeyId parameter, Amazon RDS encrypts the target DB snapshot using
the specified KMS encryption key.
If you copy an encrypted DB 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 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 KmsKeyId.
cdsTags :: Lens' CopyDBSnapshot [Tag] Source
Undocumented member.
cdsSourceDBSnapshotIdentifier :: Lens' CopyDBSnapshot Text Source
The identifier for the source DB snapshot.
If you are copying from a shared manual DB snapshot, this must be the ARN of the shared DB snapshot.
Constraints:
- Must specify a valid system snapshot in the "available" state.
- If the source snapshot is in the same region as the copy, specify a valid DB snapshot identifier.
- If the source snapshot is in a different region than the copy, specify a valid DB snapshot ARN. For more information, go to Copying a DB Snapshot.
Example: 'rds:mydb-2012-04-02-00-01'
Example: 'arn:aws:rds:rr-regn-1:123456789012:snapshot:mysql-instance1-snapshot-20130805'
cdsTargetDBSnapshotIdentifier :: Lens' CopyDBSnapshot Text Source
The identifier for the copied snapshot.
Constraints:
- Cannot be null, empty, or blank
- Must contain from 1 to 255 alphanumeric characters 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
Arguments
| :: Int | |
| -> 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:
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.