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

Inherits:
Struct
  • Object
show all
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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#authArray<Types::UserAuthConfigInfo>

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

Returns:



8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 8566

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_dateTime

The date and time when the proxy was first created.

Returns:

  • (Time)


8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 8566

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_arnString

The Amazon Resource Name (ARN) for the proxy.

Returns:

  • (String)


8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 8566

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_nameString

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)


8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 8566

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_loggingBoolean

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)


8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 8566

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

#endpointString

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)


8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 8566

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_familyString

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

Returns:

  • (String)


8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 8566

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_timeoutInteger

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)


8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 8566

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_tlsBoolean

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

Returns:

  • (Boolean)


8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 8566

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_arnString

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

Returns:

  • (String)


8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 8566

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

#statusString

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)


8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 8566

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_dateTime

The date and time when the proxy was last updated.

Returns:

  • (Time)


8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 8566

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_idString

Provides the VPC ID of the DB proxy.

Returns:

  • (String)


8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 8566

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_idsArray<String>

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

Returns:

  • (Array<String>)


8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 8566

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_idsArray<String>

The EC2 subnet IDs for the proxy.

Returns:

  • (Array<String>)


8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 8566

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