aws-cdk-lib.aws_iot.CfnAuthorizerProps

interface CfnAuthorizerProps

LanguageType name
.NETAmazon.CDK.AWS.IoT.CfnAuthorizerProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsiot#CfnAuthorizerProps
Javasoftware.amazon.awscdk.services.iot.CfnAuthorizerProps
Pythonaws_cdk.aws_iot.CfnAuthorizerProps
TypeScript aws-cdk-lib » aws_iot » CfnAuthorizerProps

Properties for defining a CfnAuthorizer.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iot as iot } from 'aws-cdk-lib';
const cfnAuthorizerProps: iot.CfnAuthorizerProps = {
  authorizerFunctionArn: 'authorizerFunctionArn',

  // the properties below are optional
  authorizerName: 'authorizerName',
  enableCachingForHttp: false,
  signingDisabled: false,
  status: 'status',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  tokenKeyName: 'tokenKeyName',
  tokenSigningPublicKeys: {
    tokenSigningPublicKeysKey: 'tokenSigningPublicKeys',
  },
};

Properties

NameTypeDescription
authorizerFunctionArnstringThe authorizer's Lambda function ARN.
authorizerName?stringThe authorizer name.
enableCachingForHttp?boolean | IResolvableWhen true , the result from the authorizer's Lambda function is cached for clients that use persistent HTTP connections.
signingDisabled?boolean | IResolvableSpecifies whether AWS IoT validates the token signature in an authorization request.
status?stringThe status of the authorizer.
tags?CfnTag[]Metadata which can be used to manage the custom authorizer.
tokenKeyName?stringThe key used to extract the token from the HTTP headers.
tokenSigningPublicKeys?IResolvable | { [string]: string }The public keys used to validate the token signature returned by your custom authentication service.

authorizerFunctionArn

Type: string

The authorizer's Lambda function ARN.


authorizerName?

Type: string (optional)

The authorizer name.


enableCachingForHttp?

Type: boolean | IResolvable (optional)

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.


signingDisabled?

Type: boolean | IResolvable (optional)

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


status?

Type: string (optional)

The status of the authorizer.

Valid values: ACTIVE | INACTIVE


tags?

Type: CfnTag[] (optional)

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


tokenKeyName?

Type: string (optional)

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


tokenSigningPublicKeys?

Type: IResolvable | { [string]: string } (optional)

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