class Authorizer

Language	Type name
.NET	Amazon.CDK.AWS.APIGateway.Authorizer
Java	software.amazon.awscdk.services.apigateway.Authorizer
Python	aws_cdk.aws_apigateway.Authorizer
TypeScript (source)	@aws-cdk/aws-apigateway » Authorizer

Implements IConstruct, IConstruct, IDependable, IResource, IAuthorizer

Extends Resource

Implemented by CognitoUserPoolsAuthorizer, RequestAuthorizer, TokenAuthorizer

Base class for all custom authorizers.

Initializer

new Authorizer(scope: Construct, id: string, props?: ResourceProps)

Parameters

• scope Construct
• id string
• props ResourceProps

Properties

Name	Type	Description
authorizerId	string	The authorizer ID.
env	ResourceEnvironment	The environment this resource belongs to.
node	ConstructNode	The construct tree node associated with this construct.
stack	Stack	The stack in which this resource is defined.
authorizationType?	AuthorizationType	The authorization type of this authorizer.

---

authorizerId

Type: string

The authorizer ID.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

node

Type: ConstructNode

The construct tree node associated with this construct.

---

stack

Type: Stack

The stack in which this resource is defined.

---

authorizationType?

Type: AuthorizationType (optional)

The authorization type of this authorizer.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
toString()	Returns a string representation of this construct.
static isAuthorizer(x)	Return whether the given object is an Authorizer.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

static isAuthorizer(x)

public static isAuthorizer(x: any): boolean

Parameters

• x any

Returns

• boolean

Return whether the given object is an Authorizer.