aws rds create-db-proxy-endpoint

Creates a DBProxyEndpoint. AWS CLI reference

1 example 7 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

To create a DB proxy endpoint for an RDS database

The following create-db-proxy-endpoint example creates a DB proxy endpoint.

aws rds create-db-proxy-endpoint --db-proxy-name proxyExample --db-proxy-endpoint-name "proxyep1" --vpc-subnet-ids subnetgroup1 subnetgroup2

Identify

--db-proxy-nameThe name of the DB proxy associated with the DB proxy endpoint that you create.

--db-proxy-endpoint-nameThe name of the DB proxy endpoint to create.

--vpc-subnet-idsThe VPC subnet IDs for the DB proxy endpoint that you create.

Its output

{
    "DBProxyEndpoint": {
        "DBProxyEndpointName": "proxyep1",
        "DBProxyEndpointArn": "arn:aws:rds:us-west-2:123456789012:db-proxy-endpoint:prx-endpoint-0123a01b12345c0ab",
        "DBProxyName": "proxyExample",
        "Status": "creating",
        "VpcId": "vpc-1234567",
        "VpcSecurityGroupIds": [
            "sg-1234",
            "sg-5678"
        ],
        "VpcSubnetIds": [
            "subnetgroup1",
            "subnetgroup2"
        ],
        "Endpoint": "proxyep1.endpoint.proxy-ab0cd1efghij.us-west-2.rds.amazonaws.com",
        "CreatedDate": "2023-04-05T16:09:33.452000+00:00",
        "TargetRole": "READ_WRITE",
        "IsDefault": false
    }
}

For more information, see Creating a proxy endpoint in the Amazon RDS User Guide and Creating a proxy endpoint in the Amazon Aurora User Guide.

Options

7 in the AWS CLI reference

--db-proxy-endpoint-nameThe name of the DB proxy endpoint to create.

--db-proxy-nameThe name of the DB proxy associated with the DB proxy endpoint that you create.

--endpoint-network-typeThe network type of the DB proxy endpoint.

--tagsA list of tags.

--target-roleThe role of the DB proxy endpoint.

--vpc-security-group-idsThe VPC security group IDs for the DB proxy endpoint that you create.

--vpc-subnet-idsThe VPC subnet IDs for the DB proxy endpoint that you create.