AWS::ServiceDiscovery::PublicDnsNamespace

The AWS::ServiceDiscovery::PublicDnsNamespace resource specifies information about a public namespace for AWS Cloud Map. Use a public namespace when you want to route internet traffic to your resources. For more information, see CreatePublicDnsNamespace in the AWS Cloud Map API Reference.

Topics

Syntax
Properties
Return Values
See Also

Syntax

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

JSON


{
  "Type" : "AWS::ServiceDiscovery::PublicDnsNamespace",
  "Properties" : {
    "Description" : String,
    "Name" : String
  }
}

YAML


Type: "AWS::ServiceDiscovery::PublicDnsNamespace"
Properties:
  Description: String
  Name: String

Properties

Description

A description for the namespace.

Required: No

Type: String

Update requires: Replacement

Name

The name that you want to assign to this namespace. When you create a namespace, AWS Cloud Map automatically creates a hosted zone that has the same name as the namespace.

Required: Yes

Type: String

Update requires: Replacement

Return Values

Ref

When you pass the logical ID of an AWS::ServiceDiscovery::PublicDnsNamespace resource to the intrinsic Ref function, the function returns the value of Id for the namespace.

For more information about using the Ref function, see Ref.

Fn::GetAtt

Fn::GetAtt returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

Id: The ID of the public namespace.
Arn: The Amazon Resource Name (ARN) of the public namespace.

For more information about using Fn::GetAtt, see Fn::GetAtt.