| 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.StartDBInstanceAutomatedBackupsReplication
Description
Enables replication of automated backups to a different Amazon Web Services Region.
For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
Synopsis
- data StartDBInstanceAutomatedBackupsReplication = StartDBInstanceAutomatedBackupsReplication' {}
- newStartDBInstanceAutomatedBackupsReplication :: Text -> StartDBInstanceAutomatedBackupsReplication
- startDBInstanceAutomatedBackupsReplication_preSignedUrl :: Lens' StartDBInstanceAutomatedBackupsReplication (Maybe Text)
- startDBInstanceAutomatedBackupsReplication_destinationRegion :: Lens' StartDBInstanceAutomatedBackupsReplication (Maybe Text)
- startDBInstanceAutomatedBackupsReplication_kmsKeyId :: Lens' StartDBInstanceAutomatedBackupsReplication (Maybe Text)
- startDBInstanceAutomatedBackupsReplication_backupRetentionPeriod :: Lens' StartDBInstanceAutomatedBackupsReplication (Maybe Int)
- startDBInstanceAutomatedBackupsReplication_sourceDBInstanceArn :: Lens' StartDBInstanceAutomatedBackupsReplication Text
- data StartDBInstanceAutomatedBackupsReplicationResponse = StartDBInstanceAutomatedBackupsReplicationResponse' {}
- newStartDBInstanceAutomatedBackupsReplicationResponse :: Int -> StartDBInstanceAutomatedBackupsReplicationResponse
- startDBInstanceAutomatedBackupsReplicationResponse_dbInstanceAutomatedBackup :: Lens' StartDBInstanceAutomatedBackupsReplicationResponse (Maybe DBInstanceAutomatedBackup)
- startDBInstanceAutomatedBackupsReplicationResponse_httpStatus :: Lens' StartDBInstanceAutomatedBackupsReplicationResponse Int
Creating a Request
data StartDBInstanceAutomatedBackupsReplication Source #
See: newStartDBInstanceAutomatedBackupsReplication smart constructor.
Constructors
| StartDBInstanceAutomatedBackupsReplication' | |
Fields
| |
Instances
newStartDBInstanceAutomatedBackupsReplication Source #
Arguments
| :: Text |
|
| -> StartDBInstanceAutomatedBackupsReplication |
Create a value of StartDBInstanceAutomatedBackupsReplication 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:preSignedUrl:StartDBInstanceAutomatedBackupsReplication', startDBInstanceAutomatedBackupsReplication_preSignedUrl - A URL that contains a Signature Version 4 signed request for the
StartDBInstanceAutomatedBackupsReplication action to be called in the
Amazon Web Services Region of the source DB instance. The presigned URL
must be a valid request for the
StartDBInstanceAutomatedBackupsReplication API action that can be
executed in the Amazon Web Services Region that contains the source DB
instance.
$sel:destinationRegion:StartDBInstanceAutomatedBackupsReplication', startDBInstanceAutomatedBackupsReplication_destinationRegion - Pseudo-parameter used when populating the PreSignedUrl of a
cross-region StartDBInstanceAutomatedBackupsReplication 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:StartDBInstanceAutomatedBackupsReplication', startDBInstanceAutomatedBackupsReplication_kmsKeyId - The Amazon Web Services KMS key identifier for encryption of the
replicated automated backups. The KMS key ID is the Amazon Resource Name
(ARN) for the KMS encryption key in the destination Amazon Web Services
Region, for example,
arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE.
$sel:backupRetentionPeriod:StartDBInstanceAutomatedBackupsReplication', startDBInstanceAutomatedBackupsReplication_backupRetentionPeriod - The retention period for the replicated automated backups.
$sel:sourceDBInstanceArn:StartDBInstanceAutomatedBackupsReplication', startDBInstanceAutomatedBackupsReplication_sourceDBInstanceArn - The Amazon Resource Name (ARN) of the source DB instance for the
replicated automated backups, for example,
arn:aws:rds:us-west-2:123456789012:db:mydatabase.
Request Lenses
startDBInstanceAutomatedBackupsReplication_preSignedUrl :: Lens' StartDBInstanceAutomatedBackupsReplication (Maybe Text) Source #
A URL that contains a Signature Version 4 signed request for the StartDBInstanceAutomatedBackupsReplication action to be called in the Amazon Web Services Region of the source DB instance. The presigned URL must be a valid request for the StartDBInstanceAutomatedBackupsReplication API action that can be executed in the Amazon Web Services Region that contains the source DB instance.
startDBInstanceAutomatedBackupsReplication_destinationRegion :: Lens' StartDBInstanceAutomatedBackupsReplication (Maybe Text) Source #
Pseudo-parameter used when populating the PreSignedUrl of a
cross-region StartDBInstanceAutomatedBackupsReplication 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.
startDBInstanceAutomatedBackupsReplication_kmsKeyId :: Lens' StartDBInstanceAutomatedBackupsReplication (Maybe Text) Source #
The Amazon Web Services KMS key identifier for encryption of the
replicated automated backups. The KMS key ID is the Amazon Resource Name
(ARN) for the KMS encryption key in the destination Amazon Web Services
Region, for example,
arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE.
startDBInstanceAutomatedBackupsReplication_backupRetentionPeriod :: Lens' StartDBInstanceAutomatedBackupsReplication (Maybe Int) Source #
The retention period for the replicated automated backups.
startDBInstanceAutomatedBackupsReplication_sourceDBInstanceArn :: Lens' StartDBInstanceAutomatedBackupsReplication Text Source #
The Amazon Resource Name (ARN) of the source DB instance for the
replicated automated backups, for example,
arn:aws:rds:us-west-2:123456789012:db:mydatabase.
Destructuring the Response
data StartDBInstanceAutomatedBackupsReplicationResponse Source #
See: newStartDBInstanceAutomatedBackupsReplicationResponse smart constructor.
Constructors
| StartDBInstanceAutomatedBackupsReplicationResponse' | |
Fields
| |
Instances
newStartDBInstanceAutomatedBackupsReplicationResponse Source #
Arguments
| :: Int |
|
| -> StartDBInstanceAutomatedBackupsReplicationResponse |
Create a value of StartDBInstanceAutomatedBackupsReplicationResponse 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:dbInstanceAutomatedBackup:StartDBInstanceAutomatedBackupsReplicationResponse', startDBInstanceAutomatedBackupsReplicationResponse_dbInstanceAutomatedBackup - Undocumented member.
$sel:httpStatus:StartDBInstanceAutomatedBackupsReplicationResponse', startDBInstanceAutomatedBackupsReplicationResponse_httpStatus - The response's http status code.
Response Lenses
startDBInstanceAutomatedBackupsReplicationResponse_dbInstanceAutomatedBackup :: Lens' StartDBInstanceAutomatedBackupsReplicationResponse (Maybe DBInstanceAutomatedBackup) Source #
Undocumented member.
startDBInstanceAutomatedBackupsReplicationResponse_httpStatus :: Lens' StartDBInstanceAutomatedBackupsReplicationResponse Int Source #
The response's http status code.