Skip to content

RDS  >  Operations  >  create_db_proxy_endpoint

create_db_proxy_endpoint

Operation

create_db_proxy_endpoint async 

create_db_proxy_endpoint(input: CreateDBProxyEndpointInput, plugins: list[Plugin] | None = None) -> CreateDBProxyEndpointOutput

Creates a DBProxyEndpoint. Only applies to proxies that are associated with Aurora DB clusters. You can use DB proxy endpoints to specify read/write or read-only access to the DB cluster. You can also use DB proxy endpoints to access a DB proxy through a different VPC than the proxy's default VPC.

Parameters:

Name Type Description Default
input CreateDBProxyEndpointInput

An instance of CreateDBProxyEndpointInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
CreateDBProxyEndpointOutput

An instance of CreateDBProxyEndpointOutput.

Input

CreateDBProxyEndpointInput dataclass

Bases: _SerdeShape

Dataclass for CreateDBProxyEndpointInput structure.

Attributes

db_proxy_endpoint_name class-attribute instance-attribute 
db_proxy_endpoint_name: str | None = ...

The name of the DB proxy endpoint to create.

db_proxy_name class-attribute instance-attribute 
db_proxy_name: str | None = ...

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

endpoint_network_type class-attribute instance-attribute 
endpoint_network_type: str | None = ...

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 class-attribute instance-attribute 
tags: list[Tag] | None = ...

A list of tags.

For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.

target_role class-attribute instance-attribute 
target_role: str | None = ...

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 class-attribute instance-attribute 
vpc_security_group_ids: list[str] | None = ...

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 class-attribute instance-attribute 
vpc_subnet_ids: list[str] | None = ...

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.

Output

CreateDBProxyEndpointOutput dataclass

Bases: _SerdeShape

Dataclass for CreateDBProxyEndpointOutput structure.

Attributes

db_proxy_endpoint class-attribute instance-attribute 
db_proxy_endpoint: DBProxyEndpoint | None = ...

The DBProxyEndpoint object that is created by the API operation. The DB proxy endpoint that you create might provide capabilities such as read/write or read-only operations, or using a different VPC than the proxy's default VPC.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.