set-default-authorizer¶

Description¶

Sets the default authorizer. This will be used if a websocket connection is made without specifying an authorizer.

Synopsis¶

  set-default-authorizer
--authorizer-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options¶

--authorizer-name (string)

The authorizer name.

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

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To set a default authorizer

The following set-default-authorizer example sets the custom authorizer named CustomAuthorizer as the default authorizer.

aws iot set-default-authorizer \
    --authorizer-name CustomAuthorizer

Output:

{
    "authorizerName": "CustomAuthorizer",
    "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer"
}

For more information, see CreateDefaultAuthorizer in the AWS IoT API Reference.

Output¶

authorizerName -> (string)

The authorizer name.

authorizerArn -> (string)

The authorizer ARN.

Table of Contents

Feedback

User Guide