aws_sdk_rds/client/

start_db_instance_automated_backups_replication.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`StartDBInstanceAutomatedBackupsReplication`](crate::operation::start_db_instance_automated_backups_replication::builders::StartDBInstanceAutomatedBackupsReplicationFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`source_db_instance_arn(impl Into<String>)`](crate::operation::start_db_instance_automated_backups_replication::builders::StartDBInstanceAutomatedBackupsReplicationFluentBuilder::source_db_instance_arn) / [`set_source_db_instance_arn(Option<String>)`](crate::operation::start_db_instance_automated_backups_replication::builders::StartDBInstanceAutomatedBackupsReplicationFluentBuilder::set_source_db_instance_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the source DB instance for the replicated automated backups, for example, <code>arn:aws:rds:us-west-2:123456789012:db:mydatabase</code>.</p><br>
    ///   - [`backup_retention_period(i32)`](crate::operation::start_db_instance_automated_backups_replication::builders::StartDBInstanceAutomatedBackupsReplicationFluentBuilder::backup_retention_period) / [`set_backup_retention_period(Option<i32>)`](crate::operation::start_db_instance_automated_backups_replication::builders::StartDBInstanceAutomatedBackupsReplicationFluentBuilder::set_backup_retention_period):<br>required: **false**<br><p>The retention period for the replicated automated backups.</p><br>
    ///   - [`kms_key_id(impl Into<String>)`](crate::operation::start_db_instance_automated_backups_replication::builders::StartDBInstanceAutomatedBackupsReplicationFluentBuilder::kms_key_id) / [`set_kms_key_id(Option<String>)`](crate::operation::start_db_instance_automated_backups_replication::builders::StartDBInstanceAutomatedBackupsReplicationFluentBuilder::set_kms_key_id):<br>required: **false**<br><p>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, <code>arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE</code>.</p><br>
    ///   - [`pre_signed_url(impl Into<String>)`](crate::operation::start_db_instance_automated_backups_replication::builders::StartDBInstanceAutomatedBackupsReplicationFluentBuilder::pre_signed_url) / [`set_pre_signed_url(Option<String>)`](crate::operation::start_db_instance_automated_backups_replication::builders::StartDBInstanceAutomatedBackupsReplicationFluentBuilder::set_pre_signed_url):<br>required: **false**<br><p>In an Amazon Web Services GovCloud (US) Region, an URL that contains a Signature Version 4 signed request for the <code>StartDBInstanceAutomatedBackupsReplication</code> operation to call in the Amazon Web Services Region of the source DB instance. The presigned URL must be a valid request for the <code>StartDBInstanceAutomatedBackupsReplication</code> API operation that can run in the Amazon Web Services Region that contains the source DB instance.</p> <p>This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other Amazon Web Services Regions.</p> <p>To learn how to generate a Signature Version 4 signed request, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html"> Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4)</a> and <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html"> Signature Version 4 Signing Process</a>.</p><note>  <p>If you are using an Amazon Web Services SDK tool or the CLI, you can specify <code>SourceRegion</code> (or <code>--source-region</code> for the CLI) instead of specifying <code>PreSignedUrl</code> manually. Specifying <code>SourceRegion</code> autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.</p> </note><br>
    /// - On success, responds with [`StartDbInstanceAutomatedBackupsReplicationOutput`](crate::operation::start_db_instance_automated_backups_replication::StartDbInstanceAutomatedBackupsReplicationOutput) with field(s):
    ///   - [`db_instance_automated_backup(Option<DbInstanceAutomatedBackup>)`](crate::operation::start_db_instance_automated_backups_replication::StartDbInstanceAutomatedBackupsReplicationOutput::db_instance_automated_backup): <p>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.</p>
    /// - On failure, responds with [`SdkError<StartDBInstanceAutomatedBackupsReplicationError>`](crate::operation::start_db_instance_automated_backups_replication::StartDBInstanceAutomatedBackupsReplicationError)
    pub fn start_db_instance_automated_backups_replication(
        &self,
    ) -> crate::operation::start_db_instance_automated_backups_replication::builders::StartDBInstanceAutomatedBackupsReplicationFluentBuilder {
        crate::operation::start_db_instance_automated_backups_replication::builders::StartDBInstanceAutomatedBackupsReplicationFluentBuilder::new(
            self.handle.clone(),
        )
    }
}