class Aws::RDS::Types::DBProxyEndpoint

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.

@!attribute [rw] db_proxy_endpoint_name

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.
@return [String]

@!attribute [rw] db_proxy_endpoint_arn

The Amazon Resource Name (ARN) for the DB proxy endpoint.
@return [String]

@!attribute [rw] db_proxy_name

The identifier for the DB proxy that is associated with this DB
proxy endpoint.
@return [String]

@!attribute [rw] status

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.
@return [String]

@!attribute [rw] vpc_id

Provides the VPC ID of the DB proxy endpoint.
@return [String]

@!attribute [rw] vpc_security_group_ids

Provides a list of VPC security groups that the DB proxy endpoint
belongs to.
@return [Array<String>]

@!attribute [rw] vpc_subnet_ids

The EC2 subnet IDs for the DB proxy endpoint.
@return [Array<String>]

@!attribute [rw] endpoint

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.
@return [String]

@!attribute [rw] created_date

The date and time when the DB proxy endpoint was first created.
@return [Time]

@!attribute [rw] target_role

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

@!attribute [rw] is_default

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.
@return [Boolean]

@see docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBProxyEndpoint AWS API Documentation

Constants

SENSITIVE