aws_sdk_rds/operation/create_db_proxy/

builders.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::create_db_proxy::_create_db_proxy_output::CreateDbProxyOutputBuilder;

pub use crate::operation::create_db_proxy::_create_db_proxy_input::CreateDbProxyInputBuilder;

impl crate::operation::create_db_proxy::builders::CreateDbProxyInputBuilder {
    /// 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_db_proxy::CreateDbProxyOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::create_db_proxy::CreateDBProxyError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let mut fluent_builder = client.create_db_proxy();
        fluent_builder.inner = self;
        fluent_builder.send().await
    }
}
/// Fluent builder constructing a request to `CreateDBProxy`.
///
/// <p>Creates a new DB proxy.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct CreateDBProxyFluentBuilder {
    handle: ::std::sync::Arc<crate::client::Handle>,
    inner: crate::operation::create_db_proxy::builders::CreateDbProxyInputBuilder,
    config_override: ::std::option::Option<crate::config::Builder>,
}
impl
    crate::client::customize::internal::CustomizableSend<
        crate::operation::create_db_proxy::CreateDbProxyOutput,
        crate::operation::create_db_proxy::CreateDBProxyError,
    > for CreateDBProxyFluentBuilder
{
    fn send(
        self,
        config_override: crate::config::Builder,
    ) -> crate::client::customize::internal::BoxFuture<
        crate::client::customize::internal::SendResult<
            crate::operation::create_db_proxy::CreateDbProxyOutput,
            crate::operation::create_db_proxy::CreateDBProxyError,
        >,
    > {
        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
    }
}
impl CreateDBProxyFluentBuilder {
    /// Creates a new `CreateDBProxyFluentBuilder`.
    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 CreateDBProxy as a reference.
    pub fn as_input(&self) -> &crate::operation::create_db_proxy::builders::CreateDbProxyInputBuilder {
        &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_db_proxy::CreateDbProxyOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::create_db_proxy::CreateDBProxyError,
            ::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_db_proxy::CreateDBProxy::operation_runtime_plugins(
            self.handle.runtime_plugins.clone(),
            &self.handle.conf,
            self.config_override,
        );
        crate::operation::create_db_proxy::CreateDBProxy::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_db_proxy::CreateDbProxyOutput,
        crate::operation::create_db_proxy::CreateDBProxyError,
        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 identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.</p>
    pub fn db_proxy_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.db_proxy_name(input.into());
        self
    }
    /// <p>The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.</p>
    pub fn set_db_proxy_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_db_proxy_name(input);
        self
    }
    /// <p>The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.</p>
    pub fn get_db_proxy_name(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_db_proxy_name()
    }
    /// <p>The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify <code>MYSQL</code>. For Aurora PostgreSQL and RDS for PostgreSQL databases, specify <code>POSTGRESQL</code>. For RDS for Microsoft SQL Server, specify <code>SQLSERVER</code>.</p>
    pub fn engine_family(mut self, input: crate::types::EngineFamily) -> Self {
        self.inner = self.inner.engine_family(input);
        self
    }
    /// <p>The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify <code>MYSQL</code>. For Aurora PostgreSQL and RDS for PostgreSQL databases, specify <code>POSTGRESQL</code>. For RDS for Microsoft SQL Server, specify <code>SQLSERVER</code>.</p>
    pub fn set_engine_family(mut self, input: ::std::option::Option<crate::types::EngineFamily>) -> Self {
        self.inner = self.inner.set_engine_family(input);
        self
    }
    /// <p>The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify <code>MYSQL</code>. For Aurora PostgreSQL and RDS for PostgreSQL databases, specify <code>POSTGRESQL</code>. For RDS for Microsoft SQL Server, specify <code>SQLSERVER</code>.</p>
    pub fn get_engine_family(&self) -> &::std::option::Option<crate::types::EngineFamily> {
        self.inner.get_engine_family()
    }
    /// <p>The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database. Valid values are <code>NONE</code> and <code>IAM_AUTH</code>. When set to <code>IAM_AUTH</code>, the proxy uses end-to-end IAM authentication to connect to the database. If you don't specify <code>DefaultAuthScheme</code> or specify this parameter as <code>NONE</code>, you must specify the <code>Auth</code> option.</p>
    pub fn default_auth_scheme(mut self, input: crate::types::DefaultAuthScheme) -> Self {
        self.inner = self.inner.default_auth_scheme(input);
        self
    }
    /// <p>The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database. Valid values are <code>NONE</code> and <code>IAM_AUTH</code>. When set to <code>IAM_AUTH</code>, the proxy uses end-to-end IAM authentication to connect to the database. If you don't specify <code>DefaultAuthScheme</code> or specify this parameter as <code>NONE</code>, you must specify the <code>Auth</code> option.</p>
    pub fn set_default_auth_scheme(mut self, input: ::std::option::Option<crate::types::DefaultAuthScheme>) -> Self {
        self.inner = self.inner.set_default_auth_scheme(input);
        self
    }
    /// <p>The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database. Valid values are <code>NONE</code> and <code>IAM_AUTH</code>. When set to <code>IAM_AUTH</code>, the proxy uses end-to-end IAM authentication to connect to the database. If you don't specify <code>DefaultAuthScheme</code> or specify this parameter as <code>NONE</code>, you must specify the <code>Auth</code> option.</p>
    pub fn get_default_auth_scheme(&self) -> &::std::option::Option<crate::types::DefaultAuthScheme> {
        self.inner.get_default_auth_scheme()
    }
    ///
    /// Appends an item to `Auth`.
    ///
    /// To override the contents of this collection use [`set_auth`](Self::set_auth).
    ///
    /// <p>The authorization mechanism that the proxy uses.</p>
    pub fn auth(mut self, input: crate::types::UserAuthConfig) -> Self {
        self.inner = self.inner.auth(input);
        self
    }
    /// <p>The authorization mechanism that the proxy uses.</p>
    pub fn set_auth(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::UserAuthConfig>>) -> Self {
        self.inner = self.inner.set_auth(input);
        self
    }
    /// <p>The authorization mechanism that the proxy uses.</p>
    pub fn get_auth(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::UserAuthConfig>> {
        self.inner.get_auth()
    }
    /// <p>The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.</p>
    pub fn role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.role_arn(input.into());
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.</p>
    pub fn set_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_role_arn(input);
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.</p>
    pub fn get_role_arn(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_role_arn()
    }
    ///
    /// Appends an item to `VpcSubnetIds`.
    ///
    /// To override the contents of this collection use [`set_vpc_subnet_ids`](Self::set_vpc_subnet_ids).
    ///
    /// <p>One or more VPC subnet IDs to associate with the new proxy.</p>
    pub fn vpc_subnet_ids(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.vpc_subnet_ids(input.into());
        self
    }
    /// <p>One or more VPC subnet IDs to associate with the new proxy.</p>
    pub fn set_vpc_subnet_ids(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
        self.inner = self.inner.set_vpc_subnet_ids(input);
        self
    }
    /// <p>One or more VPC subnet IDs to associate with the new proxy.</p>
    pub fn get_vpc_subnet_ids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
        self.inner.get_vpc_subnet_ids()
    }
    ///
    /// Appends an item to `VpcSecurityGroupIds`.
    ///
    /// To override the contents of this collection use [`set_vpc_security_group_ids`](Self::set_vpc_security_group_ids).
    ///
    /// <p>One or more VPC security group IDs to associate with the new proxy.</p>
    pub fn vpc_security_group_ids(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.vpc_security_group_ids(input.into());
        self
    }
    /// <p>One or more VPC security group IDs to associate with the new proxy.</p>
    pub fn set_vpc_security_group_ids(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
        self.inner = self.inner.set_vpc_security_group_ids(input);
        self
    }
    /// <p>One or more VPC security group IDs to associate with the new proxy.</p>
    pub fn get_vpc_security_group_ids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
        self.inner.get_vpc_security_group_ids()
    }
    /// <p>Specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy.</p>
    pub fn require_tls(mut self, input: bool) -> Self {
        self.inner = self.inner.require_tls(input);
        self
    }
    /// <p>Specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy.</p>
    pub fn set_require_tls(mut self, input: ::std::option::Option<bool>) -> Self {
        self.inner = self.inner.set_require_tls(input);
        self
    }
    /// <p>Specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy.</p>
    pub fn get_require_tls(&self) -> &::std::option::Option<bool> {
        self.inner.get_require_tls()
    }
    /// <p>The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.</p>
    pub fn idle_client_timeout(mut self, input: i32) -> Self {
        self.inner = self.inner.idle_client_timeout(input);
        self
    }
    /// <p>The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.</p>
    pub fn set_idle_client_timeout(mut self, input: ::std::option::Option<i32>) -> Self {
        self.inner = self.inner.set_idle_client_timeout(input);
        self
    }
    /// <p>The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.</p>
    pub fn get_idle_client_timeout(&self) -> &::std::option::Option<i32> {
        self.inner.get_idle_client_timeout()
    }
    /// <p>Specifies whether the proxy logs detailed connection and query information. When you enable <code>DebugLogging</code>, the proxy captures connection details and connection pool behavior from your queries. Debug logging increases CloudWatch costs and can impact proxy performance. Enable this option only when you need to troubleshoot connection or performance issues.</p>
    pub fn debug_logging(mut self, input: bool) -> Self {
        self.inner = self.inner.debug_logging(input);
        self
    }
    /// <p>Specifies whether the proxy logs detailed connection and query information. When you enable <code>DebugLogging</code>, the proxy captures connection details and connection pool behavior from your queries. Debug logging increases CloudWatch costs and can impact proxy performance. Enable this option only when you need to troubleshoot connection or performance issues.</p>
    pub fn set_debug_logging(mut self, input: ::std::option::Option<bool>) -> Self {
        self.inner = self.inner.set_debug_logging(input);
        self
    }
    /// <p>Specifies whether the proxy logs detailed connection and query information. When you enable <code>DebugLogging</code>, the proxy captures connection details and connection pool behavior from your queries. Debug logging increases CloudWatch costs and can impact proxy performance. Enable this option only when you need to troubleshoot connection or performance issues.</p>
    pub fn get_debug_logging(&self) -> &::std::option::Option<bool> {
        self.inner.get_debug_logging()
    }
    ///
    /// Appends an item to `Tags`.
    ///
    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
    ///
    /// <p>An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.</p>
    pub fn tags(mut self, input: crate::types::Tag) -> Self {
        self.inner = self.inner.tags(input);
        self
    }
    /// <p>An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.</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>An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.</p>
    pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
        self.inner.get_tags()
    }
    /// <p>The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports.</p>
    /// <p>Valid values:</p>
    /// <ul>
    /// <li>
    /// <p><code>IPV4</code> - The proxy endpoint supports IPv4 only.</p></li>
    /// <li>
    /// <p><code>IPV6</code> - The proxy endpoint supports IPv6 only.</p></li>
    /// <li>
    /// <p><code>DUAL</code> - The proxy endpoint supports both IPv4 and IPv6.</p></li>
    /// </ul>
    /// <p>Default: <code>IPV4</code></p>
    /// <p>Constraints:</p>
    /// <ul>
    /// <li>
    /// <p>If you specify <code>IPV6</code> or <code>DUAL</code>, the VPC and all subnets must have an IPv6 CIDR block.</p></li>
    /// <li>
    /// <p>If you specify <code>IPV6</code> or <code>DUAL</code>, the VPC tenancy cannot be <code>dedicated</code>.</p></li>
    /// </ul>
    pub fn endpoint_network_type(mut self, input: crate::types::EndpointNetworkType) -> Self {
        self.inner = self.inner.endpoint_network_type(input);
        self
    }
    /// <p>The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports.</p>
    /// <p>Valid values:</p>
    /// <ul>
    /// <li>
    /// <p><code>IPV4</code> - The proxy endpoint supports IPv4 only.</p></li>
    /// <li>
    /// <p><code>IPV6</code> - The proxy endpoint supports IPv6 only.</p></li>
    /// <li>
    /// <p><code>DUAL</code> - The proxy endpoint supports both IPv4 and IPv6.</p></li>
    /// </ul>
    /// <p>Default: <code>IPV4</code></p>
    /// <p>Constraints:</p>
    /// <ul>
    /// <li>
    /// <p>If you specify <code>IPV6</code> or <code>DUAL</code>, the VPC and all subnets must have an IPv6 CIDR block.</p></li>
    /// <li>
    /// <p>If you specify <code>IPV6</code> or <code>DUAL</code>, the VPC tenancy cannot be <code>dedicated</code>.</p></li>
    /// </ul>
    pub fn set_endpoint_network_type(mut self, input: ::std::option::Option<crate::types::EndpointNetworkType>) -> Self {
        self.inner = self.inner.set_endpoint_network_type(input);
        self
    }
    /// <p>The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports.</p>
    /// <p>Valid values:</p>
    /// <ul>
    /// <li>
    /// <p><code>IPV4</code> - The proxy endpoint supports IPv4 only.</p></li>
    /// <li>
    /// <p><code>IPV6</code> - The proxy endpoint supports IPv6 only.</p></li>
    /// <li>
    /// <p><code>DUAL</code> - The proxy endpoint supports both IPv4 and IPv6.</p></li>
    /// </ul>
    /// <p>Default: <code>IPV4</code></p>
    /// <p>Constraints:</p>
    /// <ul>
    /// <li>
    /// <p>If you specify <code>IPV6</code> or <code>DUAL</code>, the VPC and all subnets must have an IPv6 CIDR block.</p></li>
    /// <li>
    /// <p>If you specify <code>IPV6</code> or <code>DUAL</code>, the VPC tenancy cannot be <code>dedicated</code>.</p></li>
    /// </ul>
    pub fn get_endpoint_network_type(&self) -> &::std::option::Option<crate::types::EndpointNetworkType> {
        self.inner.get_endpoint_network_type()
    }
    /// <p>The network type that the proxy uses to connect to the target database. The network type determines the IP version that the proxy uses for connections to the database.</p>
    /// <p>Valid values:</p>
    /// <ul>
    /// <li>
    /// <p><code>IPV4</code> - The proxy connects to the database using IPv4 only.</p></li>
    /// <li>
    /// <p><code>IPV6</code> - The proxy connects to the database using IPv6 only.</p></li>
    /// </ul>
    /// <p>Default: <code>IPV4</code></p>
    /// <p>Constraints:</p>
    /// <ul>
    /// <li>
    /// <p>If you specify <code>IPV6</code>, the database must support dual-stack mode. RDS doesn't support IPv6-only databases.</p></li>
    /// <li>
    /// <p>All targets registered with the proxy must be compatible with the specified network type.</p></li>
    /// </ul>
    pub fn target_connection_network_type(mut self, input: crate::types::TargetConnectionNetworkType) -> Self {
        self.inner = self.inner.target_connection_network_type(input);
        self
    }
    /// <p>The network type that the proxy uses to connect to the target database. The network type determines the IP version that the proxy uses for connections to the database.</p>
    /// <p>Valid values:</p>
    /// <ul>
    /// <li>
    /// <p><code>IPV4</code> - The proxy connects to the database using IPv4 only.</p></li>
    /// <li>
    /// <p><code>IPV6</code> - The proxy connects to the database using IPv6 only.</p></li>
    /// </ul>
    /// <p>Default: <code>IPV4</code></p>
    /// <p>Constraints:</p>
    /// <ul>
    /// <li>
    /// <p>If you specify <code>IPV6</code>, the database must support dual-stack mode. RDS doesn't support IPv6-only databases.</p></li>
    /// <li>
    /// <p>All targets registered with the proxy must be compatible with the specified network type.</p></li>
    /// </ul>
    pub fn set_target_connection_network_type(mut self, input: ::std::option::Option<crate::types::TargetConnectionNetworkType>) -> Self {
        self.inner = self.inner.set_target_connection_network_type(input);
        self
    }
    /// <p>The network type that the proxy uses to connect to the target database. The network type determines the IP version that the proxy uses for connections to the database.</p>
    /// <p>Valid values:</p>
    /// <ul>
    /// <li>
    /// <p><code>IPV4</code> - The proxy connects to the database using IPv4 only.</p></li>
    /// <li>
    /// <p><code>IPV6</code> - The proxy connects to the database using IPv6 only.</p></li>
    /// </ul>
    /// <p>Default: <code>IPV4</code></p>
    /// <p>Constraints:</p>
    /// <ul>
    /// <li>
    /// <p>If you specify <code>IPV6</code>, the database must support dual-stack mode. RDS doesn't support IPv6-only databases.</p></li>
    /// <li>
    /// <p>All targets registered with the proxy must be compatible with the specified network type.</p></li>
    /// </ul>
    pub fn get_target_connection_network_type(&self) -> &::std::option::Option<crate::types::TargetConnectionNetworkType> {
        self.inner.get_target_connection_network_type()
    }
}