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

Inherits:

Struct

• Object
• Struct
• Aws::RDS::Types::DBProxyEndpoint

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #created_date ⇒ Time

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

• #db_proxy_endpoint_arn ⇒ String

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

• #db_proxy_endpoint_name ⇒ String

  The name for the DB proxy endpoint.

• #db_proxy_name ⇒ String

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

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

• #is_default ⇒ Boolean

  Indicates whether this endpoint is the default endpoint for the associated DB proxy.

• #status ⇒ String

  The current status of this DB proxy endpoint.

• #target_role ⇒ String

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

• #vpc_id ⇒ String

  Provides the VPC ID of the DB proxy endpoint.

• #vpc_security_group_ids ⇒ Array<String>

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

• #vpc_subnet_ids ⇒ Array<String>

  The EC2 subnet IDs for the DB proxy endpoint.

Instance Attribute Details

#created_date ⇒ Time

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

Returns:

• (Time)

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

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

#db_proxy_endpoint_arn ⇒ String

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

Returns:

• (String)

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

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

#db_proxy_endpoint_name ⇒ String

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)

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

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

#db_proxy_name ⇒ String

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

Returns:

• (String)

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

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,
  :endpoint_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 11216

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,
  :endpoint_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 11216

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

#is_default ⇒ Boolean

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)

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

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

#status ⇒ String

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)

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

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

#target_role ⇒ String

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

Returns:

• (String)

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

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

#vpc_id ⇒ String

Provides the VPC ID of the DB proxy endpoint.

Returns:

• (String)

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

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

#vpc_security_group_ids ⇒ Array<String>

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

Returns:

• (Array<String>)

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

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

#vpc_subnet_ids ⇒ Array<String>

The EC2 subnet IDs for the DB proxy endpoint.

Returns:

• (Array<String>)

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

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