[ aws . iot ]

update-domain-configuration

Description

Updates values stored in the domain configuration. Domain configurations for default endpoints can’t be updated.

Requires permission to access the UpdateDomainConfiguration action.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-domain-configuration
--domain-configuration-name <value>
[--authorizer-config <value>]
[--domain-configuration-status <value>]
[--remove-authorizer-config | --no-remove-authorizer-config]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--domain-configuration-name (string)

The name of the domain configuration to be updated.

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

--domain-configuration-status (string)

The status to which the domain configuration should be updated.

Possible values:

• ENABLED

• DISABLED

--remove-authorizer-config | --no-remove-authorizer-config (boolean)

Removes the authorization configuration from a domain.

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To update a domain configuration

The following update-domain-configuration example disables the specified domain configuration.

aws iot update-domain-configuration \
    --domain-configuration-name "additionalDataDomain" \
    --domain-configuration-status "DISABLED"

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 that was updated.

domainConfigurationArn -> (string)

The ARN of the domain configuration that was updated.