class Aws::RDS::Types::DBProxy

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

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

@!attribute [rw] db_proxy_name

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.
@return [String]

@!attribute [rw] db_proxy_arn

The Amazon Resource Name (ARN) for the proxy.
@return [String]

@!attribute [rw] status

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.
@return [String]

@!attribute [rw] engine_family

The engine family applies to MySQL and PostgreSQL for both RDS and
Aurora.
@return [String]

@!attribute [rw] vpc_id

Provides the VPC ID of the DB proxy.
@return [String]

@!attribute [rw] vpc_security_group_ids

Provides a list of VPC security groups that the proxy belongs to.
@return [Array<String>]

@!attribute [rw] vpc_subnet_ids

The EC2 subnet IDs for the proxy.
@return [Array<String>]

@!attribute [rw] auth

One or more data structures specifying the authorization mechanism
to connect to the associated RDS DB instance or Aurora DB cluster.
@return [Array<Types::UserAuthConfigInfo>]

@!attribute [rw] role_arn

The Amazon Resource Name (ARN) for the IAM role that the proxy uses
to access Amazon Secrets Manager.
@return [String]

@!attribute [rw] endpoint

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.
@return [String]

@!attribute [rw] require_tls

Indicates whether Transport Layer Security (TLS) encryption is
required for connections to the proxy.
@return [Boolean]

@!attribute [rw] idle_client_timeout

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
@return [Integer]

@!attribute [rw] debug_logging

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.
@return [Boolean]

@!attribute [rw] created_date

The date and time when the proxy was first created.
@return [Time]

@!attribute [rw] updated_date

The date and time when the proxy was last updated.
@return [Time]

@see docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBProxy AWS API Documentation

Constants

SENSITIVE