Skip to content

Creates a public namespace based on DNS, which is visible on the internet

Description

Creates a public namespace based on DNS, which is visible on the internet. The namespace defines your service naming scheme. For example, if you name your namespace example.com and name your service backend, the resulting DNS name for the service is backend.example.com. You can discover instances that were registered with a public DNS namespace by using either a discover_instances request or using DNS. For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see Cloud Map quotas in the Cloud Map Developer Guide.

The create_public_dns_namespace API operation is not supported in the Amazon Web Services GovCloud (US) Regions.

Usage

servicediscovery_create_public_dns_namespace(Name, CreatorRequestId,
  Description, Tags, Properties)

Arguments

  • Name

    [required] The name that you want to assign to this namespace.

    Do not include sensitive information in the name. The name is publicly available using DNS queries.

  • CreatorRequestId

    A unique string that identifies the request and that allows failed create_public_dns_namespace requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string (for example, a date/timestamp).

  • Description

    A description for the namespace.

  • Tags

    The tags to add to the namespace. Each tag consists of a key and an optional value that you define. Tags keys can be up to 128 characters in length, and tag values can be up to 256 characters in length.

  • Properties

    Properties for the public DNS namespace.

Value

A list with the following syntax:

list(
  OperationId = "string"
)

Request syntax

svc$create_public_dns_namespace(
  Name = "string",
  CreatorRequestId = "string",
  Description = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  Properties = list(
    DnsProperties = list(
      SOA = list(
        TTL = 123
      )
    )
  )
)

Examples

# This example creates a public namespace based on DNS.
svc$create_public_dns_namespace(
  CreatorRequestId = "example-creator-request-id-0003",
  Description = "Example.com AWS Cloud Map Public DNS Namespace",
  Name = "example-public-dns.com"
)