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

  Specifies whether the proxy logs detailed connection and query information.

• #endpoint ⇒ String

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

• #endpoint_network_type ⇒ String

  The network type of the DB proxy endpoint.

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

• #target_connection_network_type ⇒ String

  The network type that the proxy uses to connect to the target database.

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

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,
  :endpoint_network_type,
  :target_connection_network_type)
  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 10485

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,
  :endpoint_network_type,
  :target_connection_network_type)
  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 10485

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,
  :endpoint_network_type,
  :target_connection_network_type)
  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 10485

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,
  :endpoint_network_type,
  :target_connection_network_type)
  SENSITIVE = []
  include Aws::Structure
end

#debug_logging ⇒ Boolean

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.

Returns:

• (Boolean)

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

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,
  :endpoint_network_type,
  :target_connection_network_type)
  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 10485

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,
  :endpoint_network_type,
  :target_connection_network_type)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_network_type ⇒ String

The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports.

Valid values:

• IPV4 - The proxy endpoint supports IPv4 only.

• IPV6 - The proxy endpoint supports IPv6 only.

• DUAL - The proxy endpoint supports both IPv4 and IPv6.

Returns:

• (String)

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

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,
  :endpoint_network_type,
  :target_connection_network_type)
  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 10485

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,
  :endpoint_network_type,
  :target_connection_network_type)
  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 10485

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,
  :endpoint_network_type,
  :target_connection_network_type)
  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 10485

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,
  :endpoint_network_type,
  :target_connection_network_type)
  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 10485

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,
  :endpoint_network_type,
  :target_connection_network_type)
  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 10485

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,
  :endpoint_network_type,
  :target_connection_network_type)
  SENSITIVE = []
  include Aws::Structure
end

#target_connection_network_type ⇒ String

The network type that the proxy uses to connect to the target database. The network type determines the IP version that the proxy uses for connections to the database.

Valid values:

• IPV4 - The proxy connects to the database using IPv4 only.

• IPV6 - The proxy connects to the database using IPv6 only.

Returns:

• (String)

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

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,
  :endpoint_network_type,
  :target_connection_network_type)
  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 10485

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,
  :endpoint_network_type,
  :target_connection_network_type)
  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 10485

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,
  :endpoint_network_type,
  :target_connection_network_type)
  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 10485

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,
  :endpoint_network_type,
  :target_connection_network_type)
  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 10485

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,
  :endpoint_network_type,
  :target_connection_network_type)
  SENSITIVE = []
  include Aws::Structure
end