AWS::ServiceDiscovery::HttpNamespace - AWS CloudFormation

AWS::ServiceDiscovery::HttpNamespace

The HttpNamespace resource is a Cloud Map resource type that contains information about an HTTP namespace. Service instances that you register using an HTTP namespace can be discovered using a DiscoverInstances request but can't be discovered using DNS.

For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.

Syntax

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

JSON

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

YAML

Type: AWS::ServiceDiscovery::HttpNamespace Properties: Description: String Name: String

Properties

Description

A description for the namespace.

Required: No

Type: String

Maximum: 1024

Update requires: Replacement

Name

The name that you want to assign to this namespace.

Required: Yes

Type: String

Maximum: 1024

Update requires: Replacement

Return Values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the Id for the namespace, such as ns-e4anhexample0004.

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

Fn::GetAtt

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

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The Amazon Resource Name (ARN) of the namespace, such as arn:aws:service-discovery:us-east-1:123456789012:http-namespace/http-namespace-a1bzhi.

Id

The ID of the namespace.

Examples

Create an HTTP namespace

The following example creates an HTTP namespace named example-namespace.

JSON

{ "Type" : "AWS::ServiceDiscovery::HttpNamespace", "Properties" : { "Description" : "Cloud Map HTTP namespace for resources for example.com website", "Name" : "example-namespace" } }

YAML

Type: 'AWS::ServiceDiscovery::HttpNamespace' Properties: Description: Cloud Map HTTP namespace for resources for example.com website Name: example-namespace

See Also