create_db_proxy_endpoint¶

RDS.Client.create_db_proxy_endpoint(**kwargs)¶

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.

See also: AWS API Documentation

Request Syntax

response = client.create_db_proxy_endpoint(
    DBProxyName='string',
    DBProxyEndpointName='string',
    VpcSubnetIds=[
        'string',
    ],
    VpcSecurityGroupIds=[
        'string',
    ],
    TargetRole='READ_WRITE'|'READ_ONLY',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters

DBProxyName (string) --
[REQUIRED]

The name of the DB proxy associated with the DB proxy endpoint that you create.
DBProxyEndpointName (string) --
[REQUIRED]

The name of the DB proxy endpoint to create.
VpcSubnetIds (list) --
[REQUIRED]

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.
- (string) --
VpcSecurityGroupIds (list) --
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.
- (string) --
TargetRole (string) -- A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations. The default is READ_WRITE . The only role that proxies for RDS for Microsoft SQL Server support is READ_WRITE .
Tags (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
- (dict) --
  Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
  
  For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
  - Key (string) --
    A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
  - Value (string) --
    A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").

Return type

dict

Returns

Response Syntax

{
    'DBProxyEndpoint': {
        'DBProxyEndpointName': 'string',
        'DBProxyEndpointArn': 'string',
        'DBProxyName': 'string',
        'Status': 'available'|'modifying'|'incompatible-network'|'insufficient-resource-limits'|'creating'|'deleting',
        'VpcId': 'string',
        'VpcSecurityGroupIds': [
            'string',
        ],
        'VpcSubnetIds': [
            'string',
        ],
        'Endpoint': 'string',
        'CreatedDate': datetime(2015, 1, 1),
        'TargetRole': 'READ_WRITE'|'READ_ONLY',
        'IsDefault': True|False
    }
}

Response Structure

(dict) --
- DBProxyEndpoint (dict) --
  
  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.
  - DBProxyEndpointName (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.
  - DBProxyEndpointArn (string) --
    
    The Amazon Resource Name (ARN) for the DB proxy endpoint.
  - DBProxyName (string) --
    
    The identifier for the DB proxy that is associated with this DB proxy endpoint.
  - 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.
  - VpcId (string) --
    
    Provides the VPC ID of the DB proxy endpoint.
  - VpcSecurityGroupIds (list) --
    
    Provides a list of VPC security groups that the DB proxy endpoint belongs to.
    - (string) --
  - VpcSubnetIds (list) --
    
    The EC2 subnet IDs for the DB proxy endpoint.
    - (string) --
  - 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.
  - CreatedDate (datetime) --
    
    The date and time when the DB proxy endpoint was first created.
  - TargetRole (string) --
    
    A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
  - IsDefault (boolean) --
    
    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.

Exceptions

RDS.Client.exceptions.InvalidSubnet
RDS.Client.exceptions.DBProxyNotFoundFault
RDS.Client.exceptions.DBProxyEndpointAlreadyExistsFault
RDS.Client.exceptions.DBProxyEndpointQuotaExceededFault
RDS.Client.exceptions.InvalidDBProxyStateFault

Table Of Contents

create_db_proxy_endpoint¶