AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::IoT::Authorizer

CfnAuthorizer

Specifies an authorizer.

Import

import { CfnAuthorizer } from 'aws-cdk-lib/aws-iot';

Or use the module namespace:

import * as iot from 'aws-cdk-lib/aws-iot';
// iot.CfnAuthorizer

Properties

Configuration passed to the constructor as CfnAuthorizerProps.

authorizerFunctionArnRequired
string

The authorizer's Lambda function ARN.

authorizerNameOptional
string

The authorizer name.

enableCachingForHttpOptional
boolean | IResolvable

When `true` , the result from the authorizer's Lambda function is cached for clients that use persistent HTTP connections. The results are cached for the time specified by the Lambda function in `refreshAfterInSeconds` . This value doesn't affect authorization of clients that use MQTT connections.

signingDisabledOptional
boolean | IResolvable

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

statusOptional
string

The status of the authorizer. Valid values: `ACTIVE` | `INACTIVE`

tagsOptional
CfnTag[]

Metadata which can be used to manage the custom authorizer. > 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..."

tokenKeyNameOptional
string

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

tokenSigningPublicKeysOptional
{ [key: string]: string } | IResolvable

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

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::IoT::AuthorizerView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-iot
CFN TypeAWS::IoT::Authorizer
Properties8

Related Constructs

Explore This Service

External Links