aws_sdk_rds/client/
promote_read_replica.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`PromoteReadReplica`](crate::operation::promote_read_replica::builders::PromoteReadReplicaFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`db_instance_identifier(impl Into<String>)`](crate::operation::promote_read_replica::builders::PromoteReadReplicaFluentBuilder::db_instance_identifier) / [`set_db_instance_identifier(Option<String>)`](crate::operation::promote_read_replica::builders::PromoteReadReplicaFluentBuilder::set_db_instance_identifier):<br>required: **true**<br><p>The DB instance identifier. This value is stored as a lowercase string.</p> <p>Constraints:</p> <ul>  <li>   <p>Must match the identifier of an existing read replica DB instance.</p></li> </ul> <p>Example: <code>mydbinstance</code></p><br>
    ///   - [`backup_retention_period(i32)`](crate::operation::promote_read_replica::builders::PromoteReadReplicaFluentBuilder::backup_retention_period) / [`set_backup_retention_period(Option<i32>)`](crate::operation::promote_read_replica::builders::PromoteReadReplicaFluentBuilder::set_backup_retention_period):<br>required: **false**<br><p>The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.</p> <p>Default: 1</p> <p>Constraints:</p> <ul>  <li>   <p>Must be a value from 0 to 35.</p></li>  <li>   <p>Can't be set to 0 if the DB instance is a source to read replicas.</p></li> </ul><br>
    ///   - [`preferred_backup_window(impl Into<String>)`](crate::operation::promote_read_replica::builders::PromoteReadReplicaFluentBuilder::preferred_backup_window) / [`set_preferred_backup_window(Option<String>)`](crate::operation::promote_read_replica::builders::PromoteReadReplicaFluentBuilder::set_preferred_backup_window):<br>required: **false**<br><p>The daily time range during which automated backups are created if automated backups are enabled, using the <code>BackupRetentionPeriod</code> parameter.</p> <p>The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To see the time blocks available, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html"> Adjusting the Preferred Maintenance Window</a> in the <i>Amazon RDS User Guide.</i></p> <p>Constraints:</p> <ul>  <li>   <p>Must be in the format <code>hh24:mi-hh24:mi</code>.</p></li>  <li>   <p>Must be in Universal Coordinated Time (UTC).</p></li>  <li>   <p>Must not conflict with the preferred maintenance window.</p></li>  <li>   <p>Must be at least 30 minutes.</p></li> </ul><br>
    /// - On success, responds with [`PromoteReadReplicaOutput`](crate::operation::promote_read_replica::PromoteReadReplicaOutput) with field(s):
    ///   - [`db_instance(Option<DbInstance>)`](crate::operation::promote_read_replica::PromoteReadReplicaOutput::db_instance): <p>Contains the details of an Amazon RDS DB instance.</p> <p>This data type is used as a response element in the operations <code>CreateDBInstance</code>, <code>CreateDBInstanceReadReplica</code>, <code>DeleteDBInstance</code>, <code>DescribeDBInstances</code>, <code>ModifyDBInstance</code>, <code>PromoteReadReplica</code>, <code>RebootDBInstance</code>, <code>RestoreDBInstanceFromDBSnapshot</code>, <code>RestoreDBInstanceFromS3</code>, <code>RestoreDBInstanceToPointInTime</code>, <code>StartDBInstance</code>, and <code>StopDBInstance</code>.</p>
    /// - On failure, responds with [`SdkError<PromoteReadReplicaError>`](crate::operation::promote_read_replica::PromoteReadReplicaError)
    pub fn promote_read_replica(&self) -> crate::operation::promote_read_replica::builders::PromoteReadReplicaFluentBuilder {
        crate::operation::promote_read_replica::builders::PromoteReadReplicaFluentBuilder::new(self.handle.clone())
    }
}