Skip to content

CreateDBProxyEndpointRequest

Source code in docs_src/capo_rds/types/create_db_proxy_endpoint_request.py
class CreateDBProxyEndpointRequest(TypedDict, closed=True):
    db_proxy_name: NotRequired["capo_rds.types.db_proxy_name.DBProxyName"]
    """<p>The name of the DB proxy associated with the DB proxy endpoint that you create.</p>"""
    db_proxy_endpoint_name: NotRequired[
        "capo_rds.types.db_proxy_endpoint_name.DBProxyEndpointName"
    ]
    """<p>The name of the DB proxy endpoint to create.</p>"""
    vpc_subnet_ids: NotRequired["capo_rds.types.string_list.StringList"]
    """<p>The VPC subnet IDs for the DB proxy endpoint that you create. You can specify a different set of subnet IDs than for the original DB proxy.</p>"""
    vpc_security_group_ids: NotRequired["capo_rds.types.string_list.StringList"]
    """<p>The VPC security group IDs for the DB proxy endpoint that you create. You can specify a different set of security group IDs than for the original DB proxy. The default is the default security group for the VPC.</p>"""
    target_role: NotRequired[
        "capo_rds.types.db_proxy_endpoint_target_role.DBProxyEndpointTargetRole"
    ]
    """<p>The role of the DB proxy endpoint. The role determines whether the endpoint can be used for read/write or only read operations. The default is <code>READ_WRITE</code>. The only role that proxies for RDS for Microsoft SQL Server support is <code>READ_WRITE</code>.</p>"""
    tags: NotRequired["capo_rds.types.tag_list.TagList"]
    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> <p>Default: <code>IPV4</code> </p> <p>Constraints:</p> <ul> <li> <p>If you specify <code>IPV6</code> or <code>DUAL</code>, the VPC and all subnets must have an IPv6 CIDR block.</p> </li> <li> <p>If you specify <code>IPV6</code> or <code>DUAL</code>, the VPC tenancy cannot be <code>dedicated</code>.</p> </li> </ul>"""

db_proxy_endpoint_name instance-attribute

db_proxy_endpoint_name: NotRequired[DBProxyEndpointName]

The name of the DB proxy endpoint to create.

db_proxy_name instance-attribute

db_proxy_name: NotRequired[DBProxyName]

The name of the DB proxy associated with the DB proxy endpoint that you create.

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.

Default: IPV4

Constraints:

  • If you specify IPV6 or DUAL, the VPC and all subnets must have an IPv6 CIDR block.

  • If you specify IPV6 or DUAL, the VPC tenancy cannot be dedicated.

tags instance-attribute

tags: NotRequired[TagList]

target_role instance-attribute

target_role: NotRequired[DBProxyEndpointTargetRole]

The role of the DB proxy endpoint. The role determines whether the endpoint can be used for read/write or only read operations. The default is READ_WRITE. The only role that proxies for RDS for Microsoft SQL Server support is READ_WRITE.

vpc_security_group_ids instance-attribute

vpc_security_group_ids: NotRequired[StringList]

The VPC security group IDs for the DB proxy endpoint that you create. You can specify a different set of security group IDs than for the original DB proxy. The default is the default security group for the VPC.

vpc_subnet_ids instance-attribute

vpc_subnet_ids: NotRequired[StringList]

The VPC subnet IDs for the DB proxy endpoint that you create. You can specify a different set of subnet IDs than for the original DB proxy.