AWS::RDS::DBInstance Endpoint - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::RDS::DBInstance Endpoint

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

  • CreateDBInstance

  • DescribeDBInstances

  • DeleteDBInstance

For the data structure that represents Amazon Aurora DB cluster endpoints, see DBClusterEndpoint.

Syntax

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

JSON

{
  "Address" : String,
  "HostedZoneId" : String,
  "Port" : String
}

YAML

  Address: String
  HostedZoneId: String
  Port: String

Properties

Address

Specifies the DNS address of the DB instance.

Required: No

Type: String

Update requires: No interruption

HostedZoneId

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

Required: No

Type: String

Update requires: No interruption

Port

Specifies the port that the database engine is listening on.

Required: No

Type: String

Update requires: No interruption