AWS::RDS::DBProxy

RDS DBProxy

Resource schema for AWS::RDS::DBProxy

Properties

13 configurable properties. 4 required. Click a row to see details.

Filter:

Property	Type	Flags
`DBProxyName`	`string`	RequiredCreate-only
`EngineFamily`	`string`	RequiredCreate-only
`RoleArn`	`string`	Required
`VpcSubnetIds`	`Array<string>`	RequiredCreate-only
`Auth`	`Array<AuthFormat>`
`DebugLogging`	`boolean`
`DefaultAuthScheme`	`string`
`EndpointNetworkType`	`string`	Create-only
`IdleClientTimeout`	`integer`
`RequireTLS`	`boolean`
`Tags`	`Array<TagFormat>`
`TargetConnectionNetworkType`	`string`	Create-only
`VpcSecurityGroupIds`	`Array<string>`

Return Values

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

Attribute	Type	Description
`DBProxyArn`	`string`	The Amazon Resource Name (ARN) for the proxy.
`Endpoint`	`string`	The endpoint that you can use to connect to the proxy. You include the endpoint value in the connection string for a database client application.
`VpcId`	`string`	VPC ID to associate with the new DB proxy.

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::DBProxy

Resources:
  MyResource:
    Type: AWS::RDS::DBProxy
    Properties:
      DBProxyName: "my-dbproxyname"
      EngineFamily: "MYSQL"
      RoleArn: "arn:aws:service:region:account:resource"
      VpcSubnetIds: "my-vpcsubnetids"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

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

create

rds:CreateDBProxyrds:DescribeDBProxiesiam:PassRole

read

rds:DescribeDBProxies

update

rds:ModifyDBProxyrds:AddTagsToResourcerds:RemoveTagsFromResourceiam:PassRole

delete

rds:DescribeDBProxiesrds:DeleteDBProxy

list

rds:DescribeDBProxies

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

Properties16

Required4

TaggingSupported

Primary IDDBProxyName

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

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

DBProxyNameEngineFamilyEndpointNetworkTypeTargetConnectionNetworkTypeVpcSubnetIds

Related Resources

External Links

AWS Documentation