Struct DbProxyBuilder 

#[non_exhaustive]
pub struct DbProxyBuilder { /* private fields */ }

A builder for DbProxy.

Implementations

impl DbProxyBuilder

pub fn db_proxy_name(self, input: impl Into<String>) -> Self

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.

pub fn set_db_proxy_name(self, input: Option<String>) -> Self

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.

pub fn get_db_proxy_name(&self) -> &Option<String>

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.

pub fn db_proxy_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) for the proxy.

pub fn set_db_proxy_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) for the proxy.

pub fn get_db_proxy_arn(&self) -> &Option<String>

The Amazon Resource Name (ARN) for the proxy.

pub fn status(self, input: DbProxyStatus) -> Self

The current status of this proxy. A status of available means the proxy is ready to handle requests. Other values indicate that you must wait for the proxy to be ready, or take some action to resolve an issue.

pub fn set_status(self, input: Option<DbProxyStatus>) -> Self

The current status of this proxy. A status of available means the proxy is ready to handle requests. Other values indicate that you must wait for the proxy to be ready, or take some action to resolve an issue.

pub fn get_status(&self) -> &Option<DbProxyStatus>

The current status of this proxy. A status of available means the proxy is ready to handle requests. Other values indicate that you must wait for the proxy to be ready, or take some action to resolve an issue.

pub fn engine_family(self, input: impl Into<String>) -> Self

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. MYSQL supports Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases. POSTGRESQL supports Aurora PostgreSQL and RDS for PostgreSQL databases. SQLSERVER supports RDS for Microsoft SQL Server databases.

pub fn set_engine_family(self, input: Option<String>) -> Self

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. MYSQL supports Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases. POSTGRESQL supports Aurora PostgreSQL and RDS for PostgreSQL databases. SQLSERVER supports RDS for Microsoft SQL Server databases.

pub fn get_engine_family(&self) -> &Option<String>

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. MYSQL supports Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases. POSTGRESQL supports Aurora PostgreSQL and RDS for PostgreSQL databases. SQLSERVER supports RDS for Microsoft SQL Server databases.

pub fn vpc_id(self, input: impl Into<String>) -> Self

Provides the VPC ID of the DB proxy.

pub fn set_vpc_id(self, input: Option<String>) -> Self

Provides the VPC ID of the DB proxy.

pub fn get_vpc_id(&self) -> &Option<String>

Provides the VPC ID of the DB proxy.

pub fn vpc_security_group_ids(self, input: impl Into<String>) -> Self

Appends an item to vpc_security_group_ids.

To override the contents of this collection use set_vpc_security_group_ids.

Provides a list of VPC security groups that the proxy belongs to.

pub fn set_vpc_security_group_ids(self, input: Option<Vec<String>>) -> Self

Provides a list of VPC security groups that the proxy belongs to.

pub fn get_vpc_security_group_ids(&self) -> &Option<Vec<String>>

Provides a list of VPC security groups that the proxy belongs to.

pub fn vpc_subnet_ids(self, input: impl Into<String>) -> Self

Appends an item to vpc_subnet_ids.

To override the contents of this collection use set_vpc_subnet_ids.

The EC2 subnet IDs for the proxy.

pub fn set_vpc_subnet_ids(self, input: Option<Vec<String>>) -> Self

The EC2 subnet IDs for the proxy.

pub fn get_vpc_subnet_ids(&self) -> &Option<Vec<String>>

The EC2 subnet IDs for the proxy.

pub fn auth(self, input: UserAuthConfigInfo) -> Self

Appends an item to auth.

To override the contents of this collection use set_auth.

One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.

pub fn set_auth(self, input: Option<Vec<UserAuthConfigInfo>>) -> Self

One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.

pub fn get_auth(&self) -> &Option<Vec<UserAuthConfigInfo>>

One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.

pub fn role_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.

pub fn set_role_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.

pub fn get_role_arn(&self) -> &Option<String>

The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.

pub fn endpoint(self, input: impl Into<String>) -> Self

The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.

pub fn set_endpoint(self, input: Option<String>) -> Self

The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.

pub fn get_endpoint(&self) -> &Option<String>

The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.

pub fn require_tls(self, input: bool) -> Self

Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.

pub fn set_require_tls(self, input: Option<bool>) -> Self

Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.

pub fn get_require_tls(&self) -> &Option<bool>

Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.

pub fn idle_client_timeout(self, input: i32) -> Self

The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection. The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by later connection requests.

Default: 1800 (30 minutes)

Constraints: 1 to 28,800

pub fn set_idle_client_timeout(self, input: Option<i32>) -> Self

The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection. The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by later connection requests.

Default: 1800 (30 minutes)

Constraints: 1 to 28,800

pub fn get_idle_client_timeout(&self) -> &Option<i32>

The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection. The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by later connection requests.

Default: 1800 (30 minutes)

Constraints: 1 to 28,800

pub fn debug_logging(self, input: bool) -> Self

Specifies whether the proxy logs detailed connection and query information. When you enable DebugLogging, 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.

pub fn set_debug_logging(self, input: Option<bool>) -> Self

Specifies whether the proxy logs detailed connection and query information. When you enable DebugLogging, 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.

pub fn get_debug_logging(&self) -> &Option<bool>

Specifies whether the proxy logs detailed connection and query information. When you enable DebugLogging, 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.

pub fn created_date(self, input: DateTime) -> Self

The date and time when the proxy was first created.

pub fn set_created_date(self, input: Option<DateTime>) -> Self

The date and time when the proxy was first created.

pub fn get_created_date(&self) -> &Option<DateTime>

The date and time when the proxy was first created.

pub fn updated_date(self, input: DateTime) -> Self

The date and time when the proxy was last updated.

pub fn set_updated_date(self, input: Option<DateTime>) -> Self

The date and time when the proxy was last updated.

pub fn get_updated_date(&self) -> &Option<DateTime>

The date and time when the proxy was last updated.

pub fn build(self) -> DbProxy

Consumes the builder and constructs a DbProxy.

Trait Implementations

impl Clone for DbProxyBuilder

fn clone(&self) -> DbProxyBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DbProxyBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DbProxyBuilder

fn default() -> DbProxyBuilder

Returns the “default value” for a type.

impl PartialEq for DbProxyBuilder

fn eq(&self, other: &DbProxyBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DbProxyBuilder