AWS::RDS::DBClusterEndpoint

RDS DBClusterEndpoint

Resource Type definition for AWS::RDS::DBClusterEndpoint. Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster. This resource applies only to Aurora DB clusters.

Properties

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

Filter:

Property	Type	Flags
`CustomEndpointType`	`string`	Required
`DBClusterEndpointIdentifier`	`string`	RequiredCreate-only
`DBClusterIdentifier`	`string`	RequiredCreate-only
`ExcludedMembers`	`Array<string>`
`StaticMembers`	`Array<string>`
`Tags`	`Array<Tag>`

Return Values

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

Attribute	Type	Description
`DBClusterEndpointArn`	`string`	The Amazon Resource Name (ARN) for the DB cluster endpoint.
`DBClusterEndpointResourceIdentifier`	`string`	A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
`Endpoint`	`string`	The DNS address of the endpoint.
`EndpointType`	`string`	The endpoint classification returned by Amazon RDS.
`Status`	`string`	The current status of the 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::DBClusterEndpoint

Resources:
  MyResource:
    Type: AWS::RDS::DBClusterEndpoint
    Properties:
      DBClusterEndpointIdentifier: "my-dbclusterendpointidentifier"
      DBClusterIdentifier: "my-dbclusteridentifier"
      CustomEndpointType: "READER"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

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

create

rds:CreateDBClusterEndpointrds:DescribeDBClusterEndpointsrds:AddTagsToResourcerds:ListTagsForResource

read

rds:DescribeDBClusterEndpointsrds:ListTagsForResource

update

rds:ModifyDBClusterEndpointrds:DescribeDBClusterEndpointsrds:AddTagsToResourcerds:RemoveTagsFromResourcerds:ListTagsForResource

delete

rds:DeleteDBClusterEndpointrds:DescribeDBClusterEndpoints

list

rds:DescribeDBClusterEndpoints

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 IDDBClusterEndpointArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

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

DBClusterEndpointIdentifierDBClusterIdentifier

Related Resources

External Links

AWS Documentation