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

Inherits:

Struct

• Object
• Struct
• Aws::RDS::Types::DBProxy

Defined in:

gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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.

• #created_date ⇒ Time

  The date and time when the proxy was first created.

• #db_proxy_arn ⇒ String

  The Amazon Resource Name (ARN) for the proxy.

• #db_proxy_name ⇒ String

  The identifier for the proxy.

• #debug_logging ⇒ Boolean

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

• #endpoint ⇒ String

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

• #engine_family ⇒ String

  The kinds of databases that the proxy can connect to.

• #idle_client_timeout ⇒ 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.

• #role_arn ⇒ 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.

• #updated_date ⇒ Time

  The date and time when the proxy was last updated.

• #vpc_id ⇒ String

  Provides the VPC ID of the DB proxy.

• #vpc_security_group_ids ⇒ 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.

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

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10082

class DBProxy < Struct.new(
  :db_proxy_name,
  :db_proxy_arn,
  :status,
  :engine_family,
  :vpc_id,
  :vpc_security_group_ids,
  :vpc_subnet_ids,
  :auth,
  :role_arn,
  :endpoint,
  :require_tls,
  :idle_client_timeout,
  :debug_logging,
  :created_date,
  :updated_date)
  SENSITIVE = []
  include Aws::Structure
end

#created_date ⇒ Time

The date and time when the proxy was first created.

Returns:

• (Time)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10082

class DBProxy < Struct.new(
  :db_proxy_name,
  :db_proxy_arn,
  :status,
  :engine_family,
  :vpc_id,
  :vpc_security_group_ids,
  :vpc_subnet_ids,
  :auth,
  :role_arn,
  :endpoint,
  :require_tls,
  :idle_client_timeout,
  :debug_logging,
  :created_date,
  :updated_date)
  SENSITIVE = []
  include Aws::Structure
end

#db_proxy_arn ⇒ String

The Amazon Resource Name (ARN) for the proxy.

Returns:

• (String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10082

class DBProxy < Struct.new(
  :db_proxy_name,
  :db_proxy_arn,
  :status,
  :engine_family,
  :vpc_id,
  :vpc_security_group_ids,
  :vpc_subnet_ids,
  :auth,
  :role_arn,
  :endpoint,
  :require_tls,
  :idle_client_timeout,
  :debug_logging,
  :created_date,
  :updated_date)
  SENSITIVE = []
  include Aws::Structure
end

#db_proxy_name ⇒ 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.

Returns:

• (String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10082

class DBProxy < Struct.new(
  :db_proxy_name,
  :db_proxy_arn,
  :status,
  :engine_family,
  :vpc_id,
  :vpc_security_group_ids,
  :vpc_subnet_ids,
  :auth,
  :role_arn,
  :endpoint,
  :require_tls,
  :idle_client_timeout,
  :debug_logging,
  :created_date,
  :updated_date)
  SENSITIVE = []
  include Aws::Structure
end

#debug_logging ⇒ Boolean

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.

Returns:

• (Boolean)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10082

class DBProxy < Struct.new(
  :db_proxy_name,
  :db_proxy_arn,
  :status,
  :engine_family,
  :vpc_id,
  :vpc_security_group_ids,
  :vpc_subnet_ids,
  :auth,
  :role_arn,
  :endpoint,
  :require_tls,
  :idle_client_timeout,
  :debug_logging,
  :created_date,
  :updated_date)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint ⇒ 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.

Returns:

• (String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10082

class DBProxy < Struct.new(
  :db_proxy_name,
  :db_proxy_arn,
  :status,
  :engine_family,
  :vpc_id,
  :vpc_security_group_ids,
  :vpc_subnet_ids,
  :auth,
  :role_arn,
  :endpoint,
  :require_tls,
  :idle_client_timeout,
  :debug_logging,
  :created_date,
  :updated_date)
  SENSITIVE = []
  include Aws::Structure
end

#engine_family ⇒ 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.

Returns:

• (String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10082

class DBProxy < Struct.new(
  :db_proxy_name,
  :db_proxy_arn,
  :status,
  :engine_family,
  :vpc_id,
  :vpc_security_group_ids,
  :vpc_subnet_ids,
  :auth,
  :role_arn,
  :endpoint,
  :require_tls,
  :idle_client_timeout,
  :debug_logging,
  :created_date,
  :updated_date)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10082

class DBProxy < Struct.new(
  :db_proxy_name,
  :db_proxy_arn,
  :status,
  :engine_family,
  :vpc_id,
  :vpc_security_group_ids,
  :vpc_subnet_ids,
  :auth,
  :role_arn,
  :endpoint,
  :require_tls,
  :idle_client_timeout,
  :debug_logging,
  :created_date,
  :updated_date)
  SENSITIVE = []
  include Aws::Structure
end

#require_tls ⇒ Boolean

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

Returns:

• (Boolean)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10082

class DBProxy < Struct.new(
  :db_proxy_name,
  :db_proxy_arn,
  :status,
  :engine_family,
  :vpc_id,
  :vpc_security_group_ids,
  :vpc_subnet_ids,
  :auth,
  :role_arn,
  :endpoint,
  :require_tls,
  :idle_client_timeout,
  :debug_logging,
  :created_date,
  :updated_date)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10082

class DBProxy < Struct.new(
  :db_proxy_name,
  :db_proxy_arn,
  :status,
  :engine_family,
  :vpc_id,
  :vpc_security_group_ids,
  :vpc_subnet_ids,
  :auth,
  :role_arn,
  :endpoint,
  :require_tls,
  :idle_client_timeout,
  :debug_logging,
  :created_date,
  :updated_date)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

• (String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10082

class DBProxy < Struct.new(
  :db_proxy_name,
  :db_proxy_arn,
  :status,
  :engine_family,
  :vpc_id,
  :vpc_security_group_ids,
  :vpc_subnet_ids,
  :auth,
  :role_arn,
  :endpoint,
  :require_tls,
  :idle_client_timeout,
  :debug_logging,
  :created_date,
  :updated_date)
  SENSITIVE = []
  include Aws::Structure
end

#updated_date ⇒ Time

The date and time when the proxy was last updated.

Returns:

• (Time)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10082

class DBProxy < Struct.new(
  :db_proxy_name,
  :db_proxy_arn,
  :status,
  :engine_family,
  :vpc_id,
  :vpc_security_group_ids,
  :vpc_subnet_ids,
  :auth,
  :role_arn,
  :endpoint,
  :require_tls,
  :idle_client_timeout,
  :debug_logging,
  :created_date,
  :updated_date)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_id ⇒ String

Provides the VPC ID of the DB proxy.

Returns:

• (String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10082

class DBProxy < Struct.new(
  :db_proxy_name,
  :db_proxy_arn,
  :status,
  :engine_family,
  :vpc_id,
  :vpc_security_group_ids,
  :vpc_subnet_ids,
  :auth,
  :role_arn,
  :endpoint,
  :require_tls,
  :idle_client_timeout,
  :debug_logging,
  :created_date,
  :updated_date)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_security_group_ids ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10082

class DBProxy < Struct.new(
  :db_proxy_name,
  :db_proxy_arn,
  :status,
  :engine_family,
  :vpc_id,
  :vpc_security_group_ids,
  :vpc_subnet_ids,
  :auth,
  :role_arn,
  :endpoint,
  :require_tls,
  :idle_client_timeout,
  :debug_logging,
  :created_date,
  :updated_date)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_subnet_ids ⇒ Array<String>

The EC2 subnet IDs for the proxy.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10082

class DBProxy < Struct.new(
  :db_proxy_name,
  :db_proxy_arn,
  :status,
  :engine_family,
  :vpc_id,
  :vpc_security_group_ids,
  :vpc_subnet_ids,
  :auth,
  :role_arn,
  :endpoint,
  :require_tls,
  :idle_client_timeout,
  :debug_logging,
  :created_date,
  :updated_date)
  SENSITIVE = []
  include Aws::Structure
end