View a markdown version of this page

AWS::RDS::DBClusterEndpoint - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::RDS::DBClusterEndpoint

This data type represents the information you need to connect to an Amazon Aurora DB cluster. This data type is used as a response element in the following actions:

  • CreateDBClusterEndpoint

  • DescribeDBClusterEndpoints

  • ModifyDBClusterEndpoint

  • DeleteDBClusterEndpoint

For the data structure that represents Amazon RDS DB instance endpoints, see Endpoint.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::RDS::DBClusterEndpoint",
  "Properties" : {
      "CustomEndpointType" : String,
      "DBClusterEndpointIdentifier" : String,
      "DBClusterIdentifier" : String,
      "ExcludedMembers" : [ String, ... ],
      "StaticMembers" : [ String, ... ],
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::RDS::DBClusterEndpoint
Properties:
  CustomEndpointType: String
  DBClusterEndpointIdentifier: String
  DBClusterIdentifier: String
  ExcludedMembers: 
    - String
  StaticMembers: 
    - String
  Tags: 
    - Tag

Properties

CustomEndpointType

The type associated with a custom endpoint. One of: READER, WRITER, ANY.

Required: Yes

Type: String

Allowed values: READER | WRITER | ANY

Update requires: No interruption

DBClusterEndpointIdentifier

The identifier associated with the endpoint. This parameter is stored as a lowercase string.

Required: Yes

Type: String

Pattern: ^[a-z][a-z0-9]*(-[a-z0-9]+)*$

Minimum: 1

Maximum: 63

Update requires: Replacement

DBClusterIdentifier

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

Required: Yes

Type: String

Pattern: ^[a-z][a-z0-9]*(-[a-z0-9]+)*$

Minimum: 1

Maximum: 63

Update requires: Replacement

ExcludedMembers

List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.

Required: No

Type: Array of String

Update requires: No interruption

StaticMembers

List of DB instance identifiers that are part of the custom endpoint group.

Required: No

Type: Array of String

Update requires: No interruption

Tags

Property description not available.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

Return values

Ref

Fn::GetAtt

DBClusterEndpointArn

The Amazon Resource Name (ARN) for the endpoint.

DBClusterEndpointResourceIdentifier

A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.

Endpoint

The DNS address of the endpoint.

EndpointType

The type of the endpoint. One of: READER, WRITER, CUSTOM.

Status

The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that can't be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.