start_db_instance_automated_backups_replication¶
Operation¶
async
¶
start_db_instance_automated_backups_replication(input: StartDBInstanceAutomatedBackupsReplicationInput, plugins: list[Plugin] | None = None) -> StartDBInstanceAutomatedBackupsReplicationOutput
Enables replication of automated backups to a different Amazon Web Services Region.
This command doesn't apply to RDS Custom.
For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
StartDBInstanceAutomatedBackupsReplicationInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
StartDBInstanceAutomatedBackupsReplicationOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for StartDBInstanceAutomatedBackupsReplicationInput structure.
Attributes¶
class-attribute
instance-attribute
¶
backup_retention_period: int | None = ...
The retention period for the replicated automated backups.
class-attribute
instance-attribute
¶
kms_key_id: str | None = ...
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.
class-attribute
instance-attribute
¶
pre_signed_url: str | None = ...
In an Amazon Web Services GovCloud (US) Region, an URL that contains a
Signature Version 4 signed request for the
StartDBInstanceAutomatedBackupsReplication operation to call in the
Amazon Web Services Region of the source DB instance. The presigned URL
must be a valid request for the
StartDBInstanceAutomatedBackupsReplication API operation that can run
in the Amazon Web Services Region that contains the source DB instance.
This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other Amazon Web Services Regions.
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.
Note
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 presigned URL that is a valid request for the operation
that can run in the source Amazon Web Services Region.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for StartDBInstanceAutomatedBackupsReplicationOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.