interface CfnAuthorizerProps

Language	Type name
.NET	Amazon.CDK.AWS.IoT.CfnAuthorizerProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsiot#CfnAuthorizerProps
Java	software.amazon.awscdk.services.iot.CfnAuthorizerProps
Python	aws_cdk.aws_iot.CfnAuthorizerProps
TypeScript	aws-cdk-lib » aws_iot » CfnAuthorizerProps

Properties for defining a CfnAuthorizer.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html

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

Name	Type	Description
authorizerFunctionArn	string	The authorizer's Lambda function ARN.
authorizerName?	string	The authorizer name.
enableCachingForHttp?	boolean | IResolvable	When true , the result from the authorizer's Lambda function is cached for clients that use persistent HTTP connections.
signingDisabled?	boolean | IResolvable	Specifies whether AWS IoT validates the token signature in an authorization request.
status?	string	The status of the authorizer.
tags?	CfnTag[]	Metadata which can be used to manage the custom authorizer.
tokenKeyName?	string	The 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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html#cfn-iot-authorizer-authorizerfunctionarn

---

authorizerName?

Type: string (optional)

The authorizer name.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html#cfn-iot-authorizer-authorizername

---

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html#cfn-iot-authorizer-enablecachingforhttp

---

signingDisabled?

Type: boolean | IResolvable (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html#cfn-iot-authorizer-signingdisabled

---

status?

Type: string (optional)

The status of the authorizer.

Valid values: ACTIVE | INACTIVE

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html#cfn-iot-authorizer-status

---

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html#cfn-iot-authorizer-tags

---

tokenKeyName?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html#cfn-iot-authorizer-tokenkeyname

---

tokenSigningPublicKeys?

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

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html#cfn-iot-authorizer-tokensigningpublickeys