Class: Aws::RDS::Types::DBProxyEndpoint

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb

Overview

The data structure representing an endpoint associated with a DB proxy. RDS automatically creates one endpoint for each DB proxy. For Aurora DB clusters, you can associate additional endpoints with the same DB proxy. These endpoints can be read/write or read-only. They can also reside in different VPCs than the associated DB proxy.

This data type is used as a response element in the DescribeDBProxyEndpoints operation.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#created_dateTime

The date and time when the DB proxy endpoint was first created.

Returns:

  • (Time)


8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 8488

class DBProxyEndpoint < Struct.new(
  :db_proxy_endpoint_name,
  :db_proxy_endpoint_arn,
  :db_proxy_name,
  :status,
  :vpc_id,
  :vpc_security_group_ids,
  :vpc_subnet_ids,
  :endpoint,
  :created_date,
  :target_role,
  :is_default)
  SENSITIVE = []
  include Aws::Structure
end

#db_proxy_endpoint_arnString

The Amazon Resource Name (ARN) for the DB proxy endpoint.

Returns:

  • (String)


8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 8488

class DBProxyEndpoint < Struct.new(
  :db_proxy_endpoint_name,
  :db_proxy_endpoint_arn,
  :db_proxy_name,
  :status,
  :vpc_id,
  :vpc_security_group_ids,
  :vpc_subnet_ids,
  :endpoint,
  :created_date,
  :target_role,
  :is_default)
  SENSITIVE = []
  include Aws::Structure
end

#db_proxy_endpoint_nameString

The name for the DB proxy endpoint. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

Returns:

  • (String)


8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 8488

class DBProxyEndpoint < Struct.new(
  :db_proxy_endpoint_name,
  :db_proxy_endpoint_arn,
  :db_proxy_name,
  :status,
  :vpc_id,
  :vpc_security_group_ids,
  :vpc_subnet_ids,
  :endpoint,
  :created_date,
  :target_role,
  :is_default)
  SENSITIVE = []
  include Aws::Structure
end

#db_proxy_nameString

The identifier for the DB proxy that is associated with this DB proxy endpoint.

Returns:

  • (String)


8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 8488

class DBProxyEndpoint < Struct.new(
  :db_proxy_endpoint_name,
  :db_proxy_endpoint_arn,
  :db_proxy_name,
  :status,
  :vpc_id,
  :vpc_security_group_ids,
  :vpc_subnet_ids,
  :endpoint,
  :created_date,
  :target_role,
  :is_default)
  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)


8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 8488

class DBProxyEndpoint < Struct.new(
  :db_proxy_endpoint_name,
  :db_proxy_endpoint_arn,
  :db_proxy_name,
  :status,
  :vpc_id,
  :vpc_security_group_ids,
  :vpc_subnet_ids,
  :endpoint,
  :created_date,
  :target_role,
  :is_default)
  SENSITIVE = []
  include Aws::Structure
end

#is_defaultBoolean

A value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.

Returns:

  • (Boolean)


8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 8488

class DBProxyEndpoint < Struct.new(
  :db_proxy_endpoint_name,
  :db_proxy_endpoint_arn,
  :db_proxy_name,
  :status,
  :vpc_id,
  :vpc_security_group_ids,
  :vpc_subnet_ids,
  :endpoint,
  :created_date,
  :target_role,
  :is_default)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The current status of this DB proxy endpoint. A status of available means the endpoint is ready to handle requests. Other values indicate that you must wait for the endpoint to be ready, or take some action to resolve an issue.

Returns:

  • (String)


8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 8488

class DBProxyEndpoint < Struct.new(
  :db_proxy_endpoint_name,
  :db_proxy_endpoint_arn,
  :db_proxy_name,
  :status,
  :vpc_id,
  :vpc_security_group_ids,
  :vpc_subnet_ids,
  :endpoint,
  :created_date,
  :target_role,
  :is_default)
  SENSITIVE = []
  include Aws::Structure
end

#target_roleString

A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.

Returns:

  • (String)


8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 8488

class DBProxyEndpoint < Struct.new(
  :db_proxy_endpoint_name,
  :db_proxy_endpoint_arn,
  :db_proxy_name,
  :status,
  :vpc_id,
  :vpc_security_group_ids,
  :vpc_subnet_ids,
  :endpoint,
  :created_date,
  :target_role,
  :is_default)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_idString

Provides the VPC ID of the DB proxy endpoint.

Returns:

  • (String)


8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 8488

class DBProxyEndpoint < Struct.new(
  :db_proxy_endpoint_name,
  :db_proxy_endpoint_arn,
  :db_proxy_name,
  :status,
  :vpc_id,
  :vpc_security_group_ids,
  :vpc_subnet_ids,
  :endpoint,
  :created_date,
  :target_role,
  :is_default)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_security_group_idsArray<String>

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

Returns:

  • (Array<String>)


8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 8488

class DBProxyEndpoint < Struct.new(
  :db_proxy_endpoint_name,
  :db_proxy_endpoint_arn,
  :db_proxy_name,
  :status,
  :vpc_id,
  :vpc_security_group_ids,
  :vpc_subnet_ids,
  :endpoint,
  :created_date,
  :target_role,
  :is_default)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_subnet_idsArray<String>

The EC2 subnet IDs for the DB proxy endpoint.

Returns:

  • (Array<String>)


8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 8488

class DBProxyEndpoint < Struct.new(
  :db_proxy_endpoint_name,
  :db_proxy_endpoint_arn,
  :db_proxy_name,
  :status,
  :vpc_id,
  :vpc_security_group_ids,
  :vpc_subnet_ids,
  :endpoint,
  :created_date,
  :target_role,
  :is_default)
  SENSITIVE = []
  include Aws::Structure
end