AWS::ServiceDiscovery::PrivateDnsNamespace

The AWS::ServiceDiscovery::PrivateDnsNamespace resource specifies information about a private namespace for AWS Cloud Map. Use a private namespace when you want to route traffic inside an Amazon VPC. For more information, see CreatePrivateDnsNamespace 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::PrivateDnsNamespace",
  "Properties" : {
    "Description" : String,
    "Vpc" : String,
    "Name" : String
  }
}

YAML


Type: "AWS::ServiceDiscovery::PrivateDnsNamespace"
Properties:
  Description: String
  Vpc: String
  Name: String

Properties

Description

A description for the namespace.

Required: No

Type: String

Update requires: Replacement

Vpc

The ID of the Amazon VPC that you want to associate the namespace with.

Required: Yes

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::PrivateDnsNamespace 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 private namespace.
Arn: The Amazon Resource Name (ARN) of the private namespace.

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

AWS::ServiceDiscovery::PrivateDnsNamespace

Syntax

JSON

YAML

Properties

Return Values

Ref

Fn::GetAtt

See Also