AWS::RDS::DBProxyEndpoint

RDS DBProxyEndpoint

Resource schema for AWS::RDS::DBProxyEndpoint.

Properties

7 configurable properties. 3 required. Click a row to see details.

Filter:

Property	Type	Flags
`DBProxyEndpointName`	`string`	RequiredCreate-only
`DBProxyName`	`string`	RequiredCreate-only
`VpcSubnetIds`	`Array<string>`	RequiredCreate-only
`EndpointNetworkType`	`string`	Create-only
`Tags`	`Array<TagFormat>`
`TargetRole`	`string`
`VpcSecurityGroupIds`	`Array<string>`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`DBProxyEndpointArn`	`string`	The Amazon Resource Name (ARN) for the DB proxy endpoint.
`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.
`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.
`VpcId`	`string`	VPC ID to associate with the new DB proxy endpoint.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::RDS::DBProxyEndpoint

Resources:
  MyResource:
    Type: AWS::RDS::DBProxyEndpoint
    Properties:
      DBProxyName: "my-dbproxyname"
      DBProxyEndpointName: "my-dbproxyendpointname"
      VpcSubnetIds: "my-vpcsubnetids"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

rds:CreateDBProxyEndpointrds:DescribeDBProxyEndpoints

read

rds:DescribeDBProxyEndpointsrds:ListTagsForResource

update

rds:ModifyDBProxyEndpointrds:AddTagsToResourcerds:RemoveTagsFromResource

delete

rds:DescribeDBProxyEndpointsrds:DeleteDBProxyEndpoint

list

rds:DescribeDBProxyEndpoints

Get the RDS Cheat Sheet

Everything you need to know about RDS on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

ServiceRDS

Properties11

Required3

TaggingSupported

Primary IDDBProxyEndpointName

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

DBProxyNameDBProxyEndpointNameEndpointNetworkTypeVpcSubnetIds

Related Resources

External Links

AWS Documentation