ServiceDiscovery / Client / create_public_dns_namespace

create_public_dns_namespace#

ServiceDiscovery.Client.create_public_dns_namespace(**kwargs)#

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 DiscoverInstances 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.

Warning

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

See also: AWS API Documentation

Request Syntax

response = client.create_public_dns_namespace(
    Name='string',
    CreatorRequestId='string',
    Description='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    Properties={
        'DnsProperties': {
            'SOA': {
                'TTL': 123
            }
        }
    }
)
Parameters:

  • Name (string) –

    [REQUIRED]

    The name that you want to assign to this namespace.

    Note

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

  • CreatorRequestId (string) –

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

    This field is autopopulated if not provided.

  • Description (string) – A description for the namespace.

  • Tags (list) –

    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.

    • (dict) –

      A custom key-value pair that’s associated with a resource.

      • Key (string) – [REQUIRED]

        The key identifier, or name, of the tag.

      • Value (string) – [REQUIRED]

        The string value that’s associated with the key of the tag. You can set the value of a tag to an empty string, but you can’t set the value of a tag to null.

  • Properties (dict) –

    Properties for the public DNS namespace.

    • DnsProperties (dict) – [REQUIRED]

      DNS properties for the public DNS namespace.

      • SOA (dict) – [REQUIRED]

        Start of Authority (SOA) record for the hosted zone for the public DNS namespace.

        • TTL (integer) – [REQUIRED]

          The time to live (TTL) for purposes of negative caching.

Return type:

dict

Returns:

Response Syntax

{
    'OperationId': 'string'
}

Response Structure

  • (dict) –

    • OperationId (string) –

      A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.

Exceptions

  • ServiceDiscovery.Client.exceptions.InvalidInput

  • ServiceDiscovery.Client.exceptions.NamespaceAlreadyExists

  • ServiceDiscovery.Client.exceptions.ResourceLimitExceeded

  • ServiceDiscovery.Client.exceptions.DuplicateRequest

  • ServiceDiscovery.Client.exceptions.TooManyTagsException

Examples

This example creates a public namespace based on DNS.

response = client.create_public_dns_namespace(
    CreatorRequestId='example-creator-request-id-0003',
    Description='Example.com AWS Cloud Map Public DNS Namespace',
    Name='example-public-dns.com',
)

print(response)

Expected Output:

{
    'OperationId': 'dns2voqozuhfet5kzxoxg-a-response-example',
    'ResponseMetadata': {
        '...': '...',
    },
}