[ aws . servicediscovery ]

create-private-dns-namespace

Description

Creates a private namespace based on DNS, which is visible only inside a specified Amazon VPC. 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 . Service instances that are registered using a private DNS namespace can be discovered using either a DiscoverInstances request or using DNS. For the current quota on the number of namespaces that you can create using the same account, see Cloud Map quotas in the Cloud Map Developer Guide .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-private-dns-namespace
--name <value>
[--creator-request-id <value>]
[--description <value>]
--vpc <value>
[--tags <value>]
[--properties <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--name (string)

The name that you want to assign to this namespace. When you create a private DNS namespace, Cloud Map automatically creates an Amazon Route 53 private hosted zone that has the same name as the namespace.

--creator-request-id (string)

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

--description (string)

A description for the namespace.

--vpc (string)

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

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

(structure)

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

Key -> (string)

The key identifier, or name, of the tag.

Value -> (string)

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.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--properties (structure)

Properties for the private DNS namespace.

DnsProperties -> (structure)

DNS properties for the private DNS namespace.

SOA -> (structure)

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

TTL -> (long)

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

Shorthand Syntax:

DnsProperties={SOA={TTL=long}}

JSON Syntax:

{
  "DnsProperties": {
    "SOA": {
      "TTL": long
    }
  }
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To create a private DNS namespace

The following create-private-dns-namespace example creates a private DNS namespace.

aws servicediscovery create-private-dns-namespace \
    --name example.com \
    --vpc vpc-1c56417b

Output:

{
    "OperationId": "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd"
}

To confirm that the operation succeeded, you can run get-operation. For more information, see get-operation .

For more information, see Creating namespaces in the AWS Cloud Map Developer Guide.

Output

OperationId -> (string)

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