interface CfnAuthorizerProps

Language	Type name
.NET	Amazon.CDK.AWS.IoT.CfnAuthorizerProps
Java	software.amazon.awscdk.services.iot.CfnAuthorizerProps
Python	aws_cdk.aws_iot.CfnAuthorizerProps
TypeScript	@aws-cdk/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 * as iot from '@aws-cdk/aws-iot';
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	AWS::IoT::Authorizer.EnableCachingForHttp.
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.

---

authorizerName?

Type: string (optional)

The authorizer name.

---

enableCachingForHttp?

Type: boolean | IResolvable (optional)

AWS::IoT::Authorizer.EnableCachingForHttp.

---

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.