aws-sdk-rds 1.131.0

AWS SDK for Amazon Relational Database Service
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::create_blue_green_deployment::_create_blue_green_deployment_input::CreateBlueGreenDeploymentInputBuilder;

pub use crate::operation::create_blue_green_deployment::_create_blue_green_deployment_output::CreateBlueGreenDeploymentOutputBuilder;

impl crate::operation::create_blue_green_deployment::builders::CreateBlueGreenDeploymentInputBuilder {
    /// Sends a request with this input using the given client.
    pub async fn send_with(
        self,
        client: &crate::Client,
    ) -> ::std::result::Result<
        crate::operation::create_blue_green_deployment::CreateBlueGreenDeploymentOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::create_blue_green_deployment::CreateBlueGreenDeploymentError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let mut fluent_builder = client.create_blue_green_deployment();
        fluent_builder.inner = self;
        fluent_builder.send().await
    }
}
/// Fluent builder constructing a request to `CreateBlueGreenDeployment`.
///
/// <p>Creates a blue/green deployment.</p>
/// <p>A blue/green deployment creates a staging environment that copies the production environment. In a blue/green deployment, the blue environment is the current production environment. The green environment is the staging environment, and it stays in sync with the current production environment.</p>
/// <p>You can make changes to the databases in the green environment without affecting production workloads. For example, you can upgrade the major or minor DB engine version, change database parameters, or make schema changes in the staging environment. You can thoroughly test changes in the green environment. When ready, you can switch over the environments to promote the green environment to be the new production environment. The switchover typically takes under a minute.</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>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct CreateBlueGreenDeploymentFluentBuilder {
    handle: ::std::sync::Arc<crate::client::Handle>,
    inner: crate::operation::create_blue_green_deployment::builders::CreateBlueGreenDeploymentInputBuilder,
    config_override: ::std::option::Option<crate::config::Builder>,
}
impl
    crate::client::customize::internal::CustomizableSend<
        crate::operation::create_blue_green_deployment::CreateBlueGreenDeploymentOutput,
        crate::operation::create_blue_green_deployment::CreateBlueGreenDeploymentError,
    > for CreateBlueGreenDeploymentFluentBuilder
{
    fn send(
        self,
        config_override: crate::config::Builder,
    ) -> crate::client::customize::internal::BoxFuture<
        crate::client::customize::internal::SendResult<
            crate::operation::create_blue_green_deployment::CreateBlueGreenDeploymentOutput,
            crate::operation::create_blue_green_deployment::CreateBlueGreenDeploymentError,
        >,
    > {
        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
    }
}
impl CreateBlueGreenDeploymentFluentBuilder {
    /// Creates a new `CreateBlueGreenDeploymentFluentBuilder`.
    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
        Self {
            handle,
            inner: ::std::default::Default::default(),
            config_override: ::std::option::Option::None,
        }
    }
    /// Access the CreateBlueGreenDeployment as a reference.
    pub fn as_input(&self) -> &crate::operation::create_blue_green_deployment::builders::CreateBlueGreenDeploymentInputBuilder {
        &self.inner
    }
    /// Sends the request and returns the response.
    ///
    /// If an error occurs, an `SdkError` will be returned with additional details that
    /// can be matched against.
    ///
    /// By default, any retryable failures will be retried twice. Retry behavior
    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
    /// set when configuring the client.
    pub async fn send(
        self,
    ) -> ::std::result::Result<
        crate::operation::create_blue_green_deployment::CreateBlueGreenDeploymentOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::create_blue_green_deployment::CreateBlueGreenDeploymentError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let input = self
            .inner
            .build()
            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
        let runtime_plugins = crate::operation::create_blue_green_deployment::CreateBlueGreenDeployment::operation_runtime_plugins(
            self.handle.runtime_plugins.clone(),
            &self.handle.conf,
            self.config_override,
        );
        crate::operation::create_blue_green_deployment::CreateBlueGreenDeployment::orchestrate(&runtime_plugins, input).await
    }

    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
    pub fn customize(
        self,
    ) -> crate::client::customize::CustomizableOperation<
        crate::operation::create_blue_green_deployment::CreateBlueGreenDeploymentOutput,
        crate::operation::create_blue_green_deployment::CreateBlueGreenDeploymentError,
        Self,
    > {
        crate::client::customize::CustomizableOperation::new(self)
    }
    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
        self.set_config_override(::std::option::Option::Some(config_override.into()));
        self
    }

    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
        self.config_override = config_override;
        self
    }
    /// <p>The name of the blue/green deployment.</p>
    /// <p>Constraints:</p>
    /// <ul>
    /// <li>
    /// <p>Can't be the same as an existing blue/green deployment name in the same account and Amazon Web Services Region.</p></li>
    /// </ul>
    pub fn blue_green_deployment_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.blue_green_deployment_name(input.into());
        self
    }
    /// <p>The name of the blue/green deployment.</p>
    /// <p>Constraints:</p>
    /// <ul>
    /// <li>
    /// <p>Can't be the same as an existing blue/green deployment name in the same account and Amazon Web Services Region.</p></li>
    /// </ul>
    pub fn set_blue_green_deployment_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_blue_green_deployment_name(input);
        self
    }
    /// <p>The name of the blue/green deployment.</p>
    /// <p>Constraints:</p>
    /// <ul>
    /// <li>
    /// <p>Can't be the same as an existing blue/green deployment name in the same account and Amazon Web Services Region.</p></li>
    /// </ul>
    pub fn get_blue_green_deployment_name(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_blue_green_deployment_name()
    }
    /// <p>The Amazon Resource Name (ARN) of the source production database.</p>
    /// <p>Specify the database that you want to clone. The blue/green deployment creates this database in the green environment. You can make updates to the database in the green environment, such as an engine version upgrade. When you are ready, you can switch the database in the green environment to be the production database.</p>
    pub fn source(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.source(input.into());
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the source production database.</p>
    /// <p>Specify the database that you want to clone. The blue/green deployment creates this database in the green environment. You can make updates to the database in the green environment, such as an engine version upgrade. When you are ready, you can switch the database in the green environment to be the production database.</p>
    pub fn set_source(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_source(input);
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the source production database.</p>
    /// <p>Specify the database that you want to clone. The blue/green deployment creates this database in the green environment. You can make updates to the database in the green environment, such as an engine version upgrade. When you are ready, you can switch the database in the green environment to be the production database.</p>
    pub fn get_source(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_source()
    }
    /// <p>The engine version of the database in the green environment.</p>
    /// <p>Specify the engine version to upgrade to in the green environment.</p>
    pub fn target_engine_version(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.target_engine_version(input.into());
        self
    }
    /// <p>The engine version of the database in the green environment.</p>
    /// <p>Specify the engine version to upgrade to in the green environment.</p>
    pub fn set_target_engine_version(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_target_engine_version(input);
        self
    }
    /// <p>The engine version of the database in the green environment.</p>
    /// <p>Specify the engine version to upgrade to in the green environment.</p>
    pub fn get_target_engine_version(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_target_engine_version()
    }
    /// <p>The DB parameter group associated with the DB instance in the green environment.</p>
    /// <p>To test parameter changes, specify a DB parameter group that is different from the one associated with the source DB instance.</p>
    pub fn target_db_parameter_group_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.target_db_parameter_group_name(input.into());
        self
    }
    /// <p>The DB parameter group associated with the DB instance in the green environment.</p>
    /// <p>To test parameter changes, specify a DB parameter group that is different from the one associated with the source DB instance.</p>
    pub fn set_target_db_parameter_group_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_target_db_parameter_group_name(input);
        self
    }
    /// <p>The DB parameter group associated with the DB instance in the green environment.</p>
    /// <p>To test parameter changes, specify a DB parameter group that is different from the one associated with the source DB instance.</p>
    pub fn get_target_db_parameter_group_name(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_target_db_parameter_group_name()
    }
    /// <p>The DB cluster parameter group associated with the Aurora DB cluster in the green environment.</p>
    /// <p>To test parameter changes, specify a DB cluster parameter group that is different from the one associated with the source DB cluster.</p>
    pub fn target_db_cluster_parameter_group_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.target_db_cluster_parameter_group_name(input.into());
        self
    }
    /// <p>The DB cluster parameter group associated with the Aurora DB cluster in the green environment.</p>
    /// <p>To test parameter changes, specify a DB cluster parameter group that is different from the one associated with the source DB cluster.</p>
    pub fn set_target_db_cluster_parameter_group_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_target_db_cluster_parameter_group_name(input);
        self
    }
    /// <p>The DB cluster parameter group associated with the Aurora DB cluster in the green environment.</p>
    /// <p>To test parameter changes, specify a DB cluster parameter group that is different from the one associated with the source DB cluster.</p>
    pub fn get_target_db_cluster_parameter_group_name(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_target_db_cluster_parameter_group_name()
    }
    ///
    /// Appends an item to `Tags`.
    ///
    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
    ///
    /// <p>Tags to assign to the blue/green deployment.</p>
    pub fn tags(mut self, input: crate::types::Tag) -> Self {
        self.inner = self.inner.tags(input);
        self
    }
    /// <p>Tags to assign to the blue/green deployment.</p>
    pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
        self.inner = self.inner.set_tags(input);
        self
    }
    /// <p>Tags to assign to the blue/green deployment.</p>
    pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
        self.inner.get_tags()
    }
    /// <p>Specify the DB instance class for the databases in the green environment.</p>
    /// <p>This parameter only applies to RDS DB instances, because DB instances within an Aurora DB cluster can have multiple different instance classes. If you're creating a blue/green deployment from an Aurora DB cluster, don't specify this parameter. After the green environment is created, you can individually modify the instance classes of the DB instances within the green DB cluster.</p>
    pub fn target_db_instance_class(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.target_db_instance_class(input.into());
        self
    }
    /// <p>Specify the DB instance class for the databases in the green environment.</p>
    /// <p>This parameter only applies to RDS DB instances, because DB instances within an Aurora DB cluster can have multiple different instance classes. If you're creating a blue/green deployment from an Aurora DB cluster, don't specify this parameter. After the green environment is created, you can individually modify the instance classes of the DB instances within the green DB cluster.</p>
    pub fn set_target_db_instance_class(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_target_db_instance_class(input);
        self
    }
    /// <p>Specify the DB instance class for the databases in the green environment.</p>
    /// <p>This parameter only applies to RDS DB instances, because DB instances within an Aurora DB cluster can have multiple different instance classes. If you're creating a blue/green deployment from an Aurora DB cluster, don't specify this parameter. After the green environment is created, you can individually modify the instance classes of the DB instances within the green DB cluster.</p>
    pub fn get_target_db_instance_class(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_target_db_instance_class()
    }
    /// <p>Whether to upgrade the storage file system configuration on the green database. This option migrates the green DB instance from the older 32-bit file system to the preferred configuration. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.UpgradeFileSystem">Upgrading the storage file system for a DB instance</a>.</p>
    pub fn upgrade_target_storage_config(mut self, input: bool) -> Self {
        self.inner = self.inner.upgrade_target_storage_config(input);
        self
    }
    /// <p>Whether to upgrade the storage file system configuration on the green database. This option migrates the green DB instance from the older 32-bit file system to the preferred configuration. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.UpgradeFileSystem">Upgrading the storage file system for a DB instance</a>.</p>
    pub fn set_upgrade_target_storage_config(mut self, input: ::std::option::Option<bool>) -> Self {
        self.inner = self.inner.set_upgrade_target_storage_config(input);
        self
    }
    /// <p>Whether to upgrade the storage file system configuration on the green database. This option migrates the green DB instance from the older 32-bit file system to the preferred configuration. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.UpgradeFileSystem">Upgrading the storage file system for a DB instance</a>.</p>
    pub fn get_upgrade_target_storage_config(&self) -> &::std::option::Option<bool> {
        self.inner.get_upgrade_target_storage_config()
    }
    /// <p>The amount of Provisioned IOPS (input/output operations per second) to allocate for the green DB instance. For information about valid IOPS values, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html">Amazon RDS DB instance storage</a> in the <i>Amazon RDS User Guide</i>.</p>
    /// <p>This setting doesn't apply to Amazon Aurora blue/green deployments.</p>
    pub fn target_iops(mut self, input: i32) -> Self {
        self.inner = self.inner.target_iops(input);
        self
    }
    /// <p>The amount of Provisioned IOPS (input/output operations per second) to allocate for the green DB instance. For information about valid IOPS values, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html">Amazon RDS DB instance storage</a> in the <i>Amazon RDS User Guide</i>.</p>
    /// <p>This setting doesn't apply to Amazon Aurora blue/green deployments.</p>
    pub fn set_target_iops(mut self, input: ::std::option::Option<i32>) -> Self {
        self.inner = self.inner.set_target_iops(input);
        self
    }
    /// <p>The amount of Provisioned IOPS (input/output operations per second) to allocate for the green DB instance. For information about valid IOPS values, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html">Amazon RDS DB instance storage</a> in the <i>Amazon RDS User Guide</i>.</p>
    /// <p>This setting doesn't apply to Amazon Aurora blue/green deployments.</p>
    pub fn get_target_iops(&self) -> &::std::option::Option<i32> {
        self.inner.get_target_iops()
    }
    /// <p>The storage type to associate with the green DB instance.</p>
    /// <p>Valid Values: <code>gp2 | gp3 | io1 | io2</code></p>
    /// <p>This setting doesn't apply to Amazon Aurora blue/green deployments.</p>
    pub fn target_storage_type(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.target_storage_type(input.into());
        self
    }
    /// <p>The storage type to associate with the green DB instance.</p>
    /// <p>Valid Values: <code>gp2 | gp3 | io1 | io2</code></p>
    /// <p>This setting doesn't apply to Amazon Aurora blue/green deployments.</p>
    pub fn set_target_storage_type(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_target_storage_type(input);
        self
    }
    /// <p>The storage type to associate with the green DB instance.</p>
    /// <p>Valid Values: <code>gp2 | gp3 | io1 | io2</code></p>
    /// <p>This setting doesn't apply to Amazon Aurora blue/green deployments.</p>
    pub fn get_target_storage_type(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_target_storage_type()
    }
    /// <p>The amount of storage in gibibytes (GiB) to allocate for the green DB instance. You can choose to increase or decrease the allocated storage on the green DB instance.</p>
    /// <p>This setting doesn't apply to Amazon Aurora blue/green deployments.</p>
    pub fn target_allocated_storage(mut self, input: i32) -> Self {
        self.inner = self.inner.target_allocated_storage(input);
        self
    }
    /// <p>The amount of storage in gibibytes (GiB) to allocate for the green DB instance. You can choose to increase or decrease the allocated storage on the green DB instance.</p>
    /// <p>This setting doesn't apply to Amazon Aurora blue/green deployments.</p>
    pub fn set_target_allocated_storage(mut self, input: ::std::option::Option<i32>) -> Self {
        self.inner = self.inner.set_target_allocated_storage(input);
        self
    }
    /// <p>The amount of storage in gibibytes (GiB) to allocate for the green DB instance. You can choose to increase or decrease the allocated storage on the green DB instance.</p>
    /// <p>This setting doesn't apply to Amazon Aurora blue/green deployments.</p>
    pub fn get_target_allocated_storage(&self) -> &::std::option::Option<i32> {
        self.inner.get_target_allocated_storage()
    }
    /// <p>The storage throughput value for the green DB instance.</p>
    /// <p>This setting applies only to the <code>gp3</code> storage type.</p>
    /// <p>This setting doesn't apply to Amazon Aurora blue/green deployments.</p>
    pub fn target_storage_throughput(mut self, input: i32) -> Self {
        self.inner = self.inner.target_storage_throughput(input);
        self
    }
    /// <p>The storage throughput value for the green DB instance.</p>
    /// <p>This setting applies only to the <code>gp3</code> storage type.</p>
    /// <p>This setting doesn't apply to Amazon Aurora blue/green deployments.</p>
    pub fn set_target_storage_throughput(mut self, input: ::std::option::Option<i32>) -> Self {
        self.inner = self.inner.set_target_storage_throughput(input);
        self
    }
    /// <p>The storage throughput value for the green DB instance.</p>
    /// <p>This setting applies only to the <code>gp3</code> storage type.</p>
    /// <p>This setting doesn't apply to Amazon Aurora blue/green deployments.</p>
    pub fn get_target_storage_throughput(&self) -> &::std::option::Option<i32> {
        self.inner.get_target_storage_throughput()
    }
}