You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::RDS::Types::DBProxy

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

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

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

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#auth ⇒ Array<Types::UserAuthConfigInfo>

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

Returns:

  • (Array<Types::UserAuthConfigInfo>) —

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

#created_date ⇒ Time

The date and time when the proxy was first created.

Returns:

  • (Time) —

    The date and time when the proxy was first created.

#db_proxy_arn ⇒ String

The Amazon Resource Name (ARN) for the proxy.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) for the proxy.

#db_proxy_name ⇒ String

The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.

Returns:

  • (String) —

    The identifier for the proxy.

#debug_logging ⇒ Boolean

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.

Returns:

  • (Boolean) —

    Whether the proxy includes detailed information about SQL statements in its logs.

#endpoint ⇒ String

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

Returns:

  • (String) —

    The endpoint that you can use to connect to the proxy.

#engine_family ⇒ String

The engine family applies to MySQL and PostgreSQL for both RDS and Aurora.

Returns:

  • (String) —

    The engine family applies to MySQL and PostgreSQL for both RDS and Aurora.

#idle_client_timeout ⇒ Integer

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

Returns:

  • (Integer) —

    The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection.

#require_tls ⇒ Boolean

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

Returns:

  • (Boolean) —

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

#role_arn ⇒ String

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

Returns:

  • (String) —

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

#status ⇒ String

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.

Possible values:

  • available
  • modifying
  • incompatible-network
  • insufficient-resource-limits
  • creating
  • deleting
  • suspended
  • suspending
  • reactivating

Returns:

  • (String) —

    The current status of this proxy.

#updated_date ⇒ Time

The date and time when the proxy was last updated.

Returns:

  • (Time) —

    The date and time when the proxy was last updated.

#vpc_security_group_ids ⇒ Array<String>

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

Returns:

  • (Array<String>) —

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

#vpc_subnet_ids ⇒ Array<String>

The EC2 subnet IDs for the proxy.

Returns:

  • (Array<String>) —

    The EC2 subnet IDs for the proxy.