aws_sdk_rds/client/
switchover_blue_green_deployment.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`SwitchoverBlueGreenDeployment`](crate::operation::switchover_blue_green_deployment::builders::SwitchoverBlueGreenDeploymentFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`blue_green_deployment_identifier(impl Into<String>)`](crate::operation::switchover_blue_green_deployment::builders::SwitchoverBlueGreenDeploymentFluentBuilder::blue_green_deployment_identifier) / [`set_blue_green_deployment_identifier(Option<String>)`](crate::operation::switchover_blue_green_deployment::builders::SwitchoverBlueGreenDeploymentFluentBuilder::set_blue_green_deployment_identifier):<br>required: **true**<br><p>The unique identifier of the blue/green deployment.</p> <p>Constraints:</p> <ul>  <li>   <p>Must match an existing blue/green deployment identifier.</p></li> </ul><br>
    ///   - [`switchover_timeout(i32)`](crate::operation::switchover_blue_green_deployment::builders::SwitchoverBlueGreenDeploymentFluentBuilder::switchover_timeout) / [`set_switchover_timeout(Option<i32>)`](crate::operation::switchover_blue_green_deployment::builders::SwitchoverBlueGreenDeploymentFluentBuilder::set_switchover_timeout):<br>required: **false**<br><p>The amount of time, in seconds, for the switchover to complete.</p> <p>Default: 300</p> <p>If the switchover takes longer than the specified duration, then any changes are rolled back, and no changes are made to the environments.</p><br>
    /// - On success, responds with [`SwitchoverBlueGreenDeploymentOutput`](crate::operation::switchover_blue_green_deployment::SwitchoverBlueGreenDeploymentOutput) with field(s):
    ///   - [`blue_green_deployment(Option<BlueGreenDeployment>)`](crate::operation::switchover_blue_green_deployment::SwitchoverBlueGreenDeploymentOutput::blue_green_deployment): <p>Details about a blue/green deployment.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html">Using Amazon RDS Blue/Green Deployments for database updates</a> in the <i>Amazon RDS User Guide</i> and <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html">Using Amazon RDS Blue/Green Deployments for database updates</a> in the <i>Amazon Aurora User Guide</i>.</p>
    /// - On failure, responds with [`SdkError<SwitchoverBlueGreenDeploymentError>`](crate::operation::switchover_blue_green_deployment::SwitchoverBlueGreenDeploymentError)
    pub fn switchover_blue_green_deployment(
        &self,
    ) -> crate::operation::switchover_blue_green_deployment::builders::SwitchoverBlueGreenDeploymentFluentBuilder {
        crate::operation::switchover_blue_green_deployment::builders::SwitchoverBlueGreenDeploymentFluentBuilder::new(self.handle.clone())
    }
}