Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . iot ]

create-domain-configuration

Description

Creates a domain configuration.

Note

The domain configuration feature is in public preview and is subject to change.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-domain-configuration
--domain-configuration-name <value>
[--domain-name <value>]
[--server-certificate-arns <value>]
[--validation-certificate-arn <value>]
[--authorizer-config <value>]
[--service-type <value>]
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--domain-configuration-name (string)

The name of the domain configuration. This value must be unique to a region.

--domain-name (string)

The name of the domain.

--server-certificate-arns (list)

The ARNs of the certificates that AWS IoT passes to the device during the TLS handshake. Currently you can specify only one certificate ARN. This value is not required for AWS-managed domains.

(string)

Syntax:

"string" "string" ...

--validation-certificate-arn (string)

The certificate used to validate the server certificate and prove domain name ownership. This certificate must be signed by a public certificate authority. This value is not required for AWS-managed domains.

--authorizer-config (structure)

An object that specifies the authorization service for a domain.

defaultAuthorizerName -> (string)

The name of the authorization service for a domain configuration.

allowAuthorizerOverride -> (boolean)

A Boolean that specifies whether the domain configuration's authorization service can be overridden.

Shorthand Syntax:

defaultAuthorizerName=string,allowAuthorizerOverride=boolean

JSON Syntax:

{
  "defaultAuthorizerName": "string",
  "allowAuthorizerOverride": true|false
}

--service-type (string)

The type of service delivered by the endpoint.

Note

AWS IoT Core currently supports only the DATA service type.

Possible values:

  • DATA
  • CREDENTIAL_PROVIDER
  • JOBS

--tags (list)

Metadata which can be used to manage the domain configuration.

Note

For URI Request parameters use format: ...key1=value1key2=value2...

For the CLI command-line parameter use format: tags "key1=value1key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1key2=value2..."

(structure)

A set of key/value pairs that are used to manage the resource.

Key -> (string)

The tag's key.

Value -> (string)

The tag's value.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

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

The following create-domain-configuration example creates an AWS-managed domain configuration with a service type of DATA.

aws iot create-domain-configuration \
    --domain-configuration-name "additionalDataDomain" \
    --service-type "DATA"

Output:

{
    "domainConfigurationName": "additionalDataDomain",
    "domainConfigurationArn": "arn:aws:iot:us-west-2:123456789012:domainconfiguration/additionalDataDomain/dikMh"
}

For more information, see Configurable Endpoints in the AWS IoT Developer Guide.

Output

domainConfigurationName -> (string)

The name of the domain configuration.

domainConfigurationArn -> (string)

The ARN of the domain configuration.