Skip to content

DBProxyEndpoint

Source code in docs_src/capo_rds/types/db_proxy_endpoint.py
class DBProxyEndpoint(TypedDict, closed=True):
    db_proxy_endpoint_name: NotRequired["capo_rds.types.string.String"]
    """<p>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.</p>"""
    db_proxy_endpoint_arn: NotRequired["capo_rds.types.string.String"]
    """<p>The Amazon Resource Name (ARN) for the DB proxy endpoint.</p>"""
    db_proxy_name: NotRequired["capo_rds.types.string.String"]
    """<p>The identifier for the DB proxy that is associated with this DB proxy endpoint.</p>"""
    status: NotRequired["capo_rds.types.db_proxy_endpoint_status.DBProxyEndpointStatus"]
    """<p>The current status of this DB proxy endpoint. A status of <code>available</code> 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.</p>"""
    vpc_id: NotRequired["capo_rds.types.string.String"]
    """<p>Provides the VPC ID of the DB proxy endpoint.</p>"""
    vpc_security_group_ids: NotRequired["capo_rds.types.string_list.StringList"]
    """<p>Provides a list of VPC security groups that the DB proxy endpoint belongs to.</p>"""
    vpc_subnet_ids: NotRequired["capo_rds.types.string_list.StringList"]
    """<p>The EC2 subnet IDs for the DB proxy endpoint.</p>"""
    endpoint: NotRequired["capo_rds.types.string.String"]
    """<p>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.</p>"""
    created_date: NotRequired["capo_rds.types.t_stamp.TStamp"]
    """<p>The date and time when the DB proxy endpoint was first created.</p>"""
    target_role: NotRequired[
        "capo_rds.types.db_proxy_endpoint_target_role.DBProxyEndpointTargetRole"
    ]
    """<p>A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.</p>"""
    is_default: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>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.</p>"""
    endpoint_network_type: NotRequired[
        "capo_rds.types.endpoint_network_type.EndpointNetworkType"
    ]
    """<p>The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports.</p> <p>Valid values:</p> <ul> <li> <p> <code>IPV4</code> - The proxy endpoint supports IPv4 only.</p> </li> <li> <p> <code>IPV6</code> - The proxy endpoint supports IPv6 only.</p> </li> <li> <p> <code>DUAL</code> - The proxy endpoint supports both IPv4 and IPv6.</p> </li> </ul>"""

created_date instance-attribute

created_date: NotRequired[TStamp]

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

db_proxy_endpoint_arn instance-attribute

db_proxy_endpoint_arn: NotRequired[String]

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

db_proxy_endpoint_name instance-attribute

db_proxy_endpoint_name: NotRequired[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.

db_proxy_name instance-attribute

db_proxy_name: NotRequired[String]

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

endpoint instance-attribute

endpoint: NotRequired[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.

endpoint_network_type instance-attribute

endpoint_network_type: NotRequired[EndpointNetworkType]

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.

is_default instance-attribute

is_default: NotRequired[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.

status instance-attribute

status: NotRequired[DBProxyEndpointStatus]

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.

target_role instance-attribute

target_role: NotRequired[DBProxyEndpointTargetRole]

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

vpc_id instance-attribute

vpc_id: NotRequired[String]

Provides the VPC ID of the DB proxy endpoint.

vpc_security_group_ids instance-attribute

vpc_security_group_ids: NotRequired[StringList]

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

vpc_subnet_ids instance-attribute

vpc_subnet_ids: NotRequired[StringList]

The EC2 subnet IDs for the DB proxy endpoint.