aws_sdk_rds/client/

create_db_proxy.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateDBProxy`](crate::operation::create_db_proxy::builders::CreateDBProxyFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`db_proxy_name(impl Into<String>)`](crate::operation::create_db_proxy::builders::CreateDBProxyFluentBuilder::db_proxy_name) / [`set_db_proxy_name(Option<String>)`](crate::operation::create_db_proxy::builders::CreateDBProxyFluentBuilder::set_db_proxy_name):<br>required: **true**<br><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><br>
    ///   - [`engine_family(EngineFamily)`](crate::operation::create_db_proxy::builders::CreateDBProxyFluentBuilder::engine_family) / [`set_engine_family(Option<EngineFamily>)`](crate::operation::create_db_proxy::builders::CreateDBProxyFluentBuilder::set_engine_family):<br>required: **true**<br><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><br>
    ///   - [`auth(UserAuthConfig)`](crate::operation::create_db_proxy::builders::CreateDBProxyFluentBuilder::auth) / [`set_auth(Option<Vec::<UserAuthConfig>>)`](crate::operation::create_db_proxy::builders::CreateDBProxyFluentBuilder::set_auth):<br>required: **true**<br><p>The authorization mechanism that the proxy uses.</p><br>
    ///   - [`role_arn(impl Into<String>)`](crate::operation::create_db_proxy::builders::CreateDBProxyFluentBuilder::role_arn) / [`set_role_arn(Option<String>)`](crate::operation::create_db_proxy::builders::CreateDBProxyFluentBuilder::set_role_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.</p><br>
    ///   - [`vpc_subnet_ids(impl Into<String>)`](crate::operation::create_db_proxy::builders::CreateDBProxyFluentBuilder::vpc_subnet_ids) / [`set_vpc_subnet_ids(Option<Vec::<String>>)`](crate::operation::create_db_proxy::builders::CreateDBProxyFluentBuilder::set_vpc_subnet_ids):<br>required: **true**<br><p>One or more VPC subnet IDs to associate with the new proxy.</p><br>
    ///   - [`vpc_security_group_ids(impl Into<String>)`](crate::operation::create_db_proxy::builders::CreateDBProxyFluentBuilder::vpc_security_group_ids) / [`set_vpc_security_group_ids(Option<Vec::<String>>)`](crate::operation::create_db_proxy::builders::CreateDBProxyFluentBuilder::set_vpc_security_group_ids):<br>required: **false**<br><p>One or more VPC security group IDs to associate with the new proxy.</p><br>
    ///   - [`require_tls(bool)`](crate::operation::create_db_proxy::builders::CreateDBProxyFluentBuilder::require_tls) / [`set_require_tls(Option<bool>)`](crate::operation::create_db_proxy::builders::CreateDBProxyFluentBuilder::set_require_tls):<br>required: **false**<br><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><br>
    ///   - [`idle_client_timeout(i32)`](crate::operation::create_db_proxy::builders::CreateDBProxyFluentBuilder::idle_client_timeout) / [`set_idle_client_timeout(Option<i32>)`](crate::operation::create_db_proxy::builders::CreateDBProxyFluentBuilder::set_idle_client_timeout):<br>required: **false**<br><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><br>
    ///   - [`debug_logging(bool)`](crate::operation::create_db_proxy::builders::CreateDBProxyFluentBuilder::debug_logging) / [`set_debug_logging(Option<bool>)`](crate::operation::create_db_proxy::builders::CreateDBProxyFluentBuilder::set_debug_logging):<br>required: **false**<br><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><br>
    ///   - [`tags(Tag)`](crate::operation::create_db_proxy::builders::CreateDBProxyFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_db_proxy::builders::CreateDBProxyFluentBuilder::set_tags):<br>required: **false**<br><p>An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.</p><br>
    /// - On success, responds with [`CreateDbProxyOutput`](crate::operation::create_db_proxy::CreateDbProxyOutput) with field(s):
    ///   - [`db_proxy(Option<DbProxy>)`](crate::operation::create_db_proxy::CreateDbProxyOutput::db_proxy): <p>The <code>DBProxy</code> structure corresponding to the new proxy.</p>
    /// - On failure, responds with [`SdkError<CreateDBProxyError>`](crate::operation::create_db_proxy::CreateDBProxyError)
    pub fn create_db_proxy(&self) -> crate::operation::create_db_proxy::builders::CreateDBProxyFluentBuilder {
        crate::operation::create_db_proxy::builders::CreateDBProxyFluentBuilder::new(self.handle.clone())
    }
}