AWS::IoT::Authorizer - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::IoT::Authorizer

Specifies an authorizer.

Syntax

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

JSON

{
  "Type" : "AWS::IoT::Authorizer",
  "Properties" : {
      "AuthorizerFunctionArn" : String,
      "AuthorizerName" : String,
      "EnableCachingForHttp" : Boolean,
      "SigningDisabled" : Boolean,
      "Status" : String,
      "Tags" : [ Tag, ... ],
      "TokenKeyName" : String,
      "TokenSigningPublicKeys" : {Key: Value, ...}
    }
}

YAML

Type: AWS::IoT::Authorizer
Properties: 
  AuthorizerFunctionArn: String
  AuthorizerName: String
  EnableCachingForHttp: Boolean
  SigningDisabled: Boolean
  Status: String
  Tags: 
    - Tag
  TokenKeyName: String
  TokenSigningPublicKeys: 
    Key: Value

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

EnableCachingForHttp

Property description not available.

Required: No

Type: Boolean

Update requires: No interruption

SigningDisabled

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

Required: No

Type: Boolean

Update requires: Replacement

Status

The status of the authorizer.

Valid values: ACTIVE | INACTIVE

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: List of Tag

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: Map of String

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Reffunction, Refreturns the authorizer name. For example:

{ "Ref": "MyAuthorizer" }

For more information about using the Reffunction, see Ref.

Fn::GetAtt

The Fn::GetAttintrinsic 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::GetAttintrinsic function, see Fn::GetAtt.

Arn

The Amazon Resource Name (ARN) of the authorizer.