Struct aws_sdk_rds::types::DbProxy

#[non_exhaustive]
pub struct DbProxy {

    pub db_proxy_name: Option<String>,
    pub db_proxy_arn: Option<String>,
    pub status: Option<DbProxyStatus>,
    pub engine_family: Option<String>,
    pub vpc_id: Option<String>,
    pub vpc_security_group_ids: Option<Vec<String>>,
    pub vpc_subnet_ids: Option<Vec<String>>,
    pub auth: Option<Vec<UserAuthConfigInfo>>,
    pub role_arn: Option<String>,
    pub endpoint: Option<String>,
    pub require_tls: Option<bool>,
    pub idle_client_timeout: Option<i32>,
    pub debug_logging: Option<bool>,
    pub created_date: Option<DateTime>,
    pub updated_date: Option<DateTime>,
}

The data structure representing a proxy managed by the RDS Proxy.

This data type is used as a response element in the DescribeDBProxies action.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

db_proxy_name: 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.

db_proxy_arn: Option<String>

The Amazon Resource Name (ARN) for the proxy.

status: 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.

engine_family: 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.

vpc_id: Option<String>

Provides the VPC ID of the DB proxy.

vpc_security_group_ids: Option<Vec<String>>

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

vpc_subnet_ids: Option<Vec<String>>

The EC2 subnet IDs for the proxy.

auth: Option<Vec<UserAuthConfigInfo>>

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

role_arn: Option<String>

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

endpoint: 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.

require_tls: Option<bool>

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

idle_client_timeout: 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

debug_logging: Option<bool>

Indicates whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.

created_date: Option<DateTime>

The date and time when the proxy was first created.

updated_date: Option<DateTime>

The date and time when the proxy was last updated.

Implementations

impl DbProxy

pub fn db_proxy_name(&self) -> Option<&str>

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) -> Option<&str>

The Amazon Resource Name (ARN) for the proxy.

pub fn 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) -> Option<&str>

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) -> Option<&str>

Provides the VPC ID of the DB proxy.

pub fn vpc_security_group_ids(&self) -> &[String]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .vpc_security_group_ids.is_none().

pub fn vpc_subnet_ids(&self) -> &[String]

The EC2 subnet IDs for the proxy.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .vpc_subnet_ids.is_none().

pub fn auth(&self) -> &[UserAuthConfigInfo]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .auth.is_none().

pub fn role_arn(&self) -> Option<&str>

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

pub fn endpoint(&self) -> Option<&str>

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) -> Option<bool>

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

pub fn 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) -> Option<bool>

Indicates whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.

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

The date and time when the proxy was first created.

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

The date and time when the proxy was last updated.

impl DbProxy

pub fn builder() -> DbProxyBuilder

Creates a new builder-style object to manufacture DbProxy.

Trait Implementations

impl Clone for DbProxy

fn clone(&self) -> DbProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DbProxy

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

Formats the value using the given formatter.

impl PartialEq for DbProxy

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for DbProxy