class Authorizer
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.APIGateway.Authorizer |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#Authorizer |
![]() | software.amazon.awscdk.services.apigateway.Authorizer |
![]() | aws_cdk.aws_apigateway.Authorizer |
![]() | aws-cdk-lib » aws_apigateway » Authorizer |
Implements
IConstruct
, IDependable
, IResource
, IAuthorizer
Extends
Resource
Implemented by
Cognito
, Request
, Token
Base class for all custom authorizers.
Initializer
new Authorizer(scope: Construct, id: string, props?: ResourceProps)
Parameters
- scope
Construct
- id
string
- props
Resource
Props
Properties
Name | Type | Description |
---|---|---|
authorizer | string | The authorizer ID. |
env | Resource | The environment this resource belongs to. |
node | Node | The tree node. |
stack | Stack | The stack in which this resource is defined. |
authorization | Authorization | The authorization type of this authorizer. |
authorizerId
Type:
string
The authorizer ID.
env
Type:
Resource
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:
Node
The tree node.
stack
Type:
Stack
The stack in which this resource is defined.
authorizationType?
Type:
Authorization
(optional)
The authorization type of this authorizer.
Methods
Name | Description |
---|---|
apply | Apply the given removal policy to this resource. |
to | Returns a string representation of this construct. |
static is | Return whether the given object is an Authorizer. |
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
Policy
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.