AWS::IoT::Authorizer - AWS CloudFormation

AWS::IoT::Authorizer

Specifies an authorizer.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::IoT::Authorizer", "Properties" : { "AuthorizerFunctionArn" : String, "AuthorizerName" : String, "SigningDisabled" : Boolean, "Status" : String, "Tags" : Tags, "TokenKeyName" : String, "TokenSigningPublicKeys" : TokenSigningPublicKeys } }

YAML

Type: AWS::IoT::Authorizer Properties: AuthorizerFunctionArn: String AuthorizerName: String SigningDisabled: Boolean Status: String Tags: Tags TokenKeyName: String TokenSigningPublicKeys: TokenSigningPublicKeys

Properties

AuthorizerFunctionArn

The authorizer's Lambda function ARN.

Required: Yes

Type: String

Update requires: No interruption

AuthorizerName

The authorizer name.

Required: No

Type: String

Update requires: Replacement

SigningDisabled

Specifies whether AWS IoT validates the token signature in an authorization request.

Required: No

Type: Boolean

Update requires: Replacement

Status

The status of the authorizer.

Required: No

Type: String

Update requires: No interruption

Tags

Metadata which can be used to manage the custom authorizer.

Note

For URI Request parameters use format: ...key1=value1&key2=value2...

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

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

Required: No

Type: Tags

Update requires: No interruption

TokenKeyName

The key used to extract the token from the HTTP headers.

Required: No

Type: String

Update requires: No interruption

TokenSigningPublicKeys

The public keys used to validate the token signature returned by your custom authentication service.

Required: No

Type: TokenSigningPublicKeys

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the authorizer name. For example:

{ "Ref": "MyAuthorizer" }

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The Amazon Resource Name (ARN) of the authorizer.