TokenAuthorizer
- class aws_cdk.aws_apigateway.TokenAuthorizer(scope, id, *, identity_source=None, validation_regex=None, handler, assume_role=None, authorizer_name=None, results_cache_ttl=None)
Bases:
Authorizer
Token based lambda authorizer that recognizes the caller’s identity as a bearer token, such as a JSON Web Token (JWT) or an OAuth token.
Based on the token, authorization is performed by a lambda function.
- Resource:
AWS::ApiGateway::Authorizer
- ExampleMetadata:
infused
Example:
# auth_fn: lambda.Function # books: apigateway.Resource auth = apigateway.TokenAuthorizer(self, "booksAuthorizer", handler=auth_fn ) books.add_method("GET", apigateway.HttpIntegration("http://amazon.com"), authorizer=auth )
- Parameters:
scope (
Construct
) –id (
str
) –identity_source (
Optional
[str
]) – The request header mapping expression for the bearer token. This is typically passed as part of the header, in which case this should bemethod.request.header.Authorizer
whereAuthorizer
is the header containing the bearer token. Default:IdentitySource.header('Authorization')
validation_regex (
Optional
[str
]) – An optional regex to be matched against the authorization token. When matched the authorizer lambda is invoked, otherwise a 401 Unauthorized is returned to the client. Default: - no regex filter will be applied.handler (
IFunction
) – The handler for the authorizer lambda function. The handler must follow a very specific protocol on the input it receives and the output it needs to produce. API Gateway has documented the handler’s input specification and output specification.assume_role (
Optional
[IRole
]) – An optional IAM role for APIGateway to assume before calling the Lambda-based authorizer. The IAM role must be assumable by ‘apigateway.amazonaws.com’. Default: - A resource policy is added to the Lambda function allowing apigateway.amazonaws.com to invoke the function.authorizer_name (
Optional
[str
]) – An optional human friendly name for the authorizer. Note that, this is not the primary identifier of the authorizer. Default: - the unique construct IDresults_cache_ttl (
Optional
[Duration
]) – How long APIGateway should cache the results. Max 1 hour. Disable caching by setting this to 0. Default: - Duration.minutes(5)
Methods
- apply_removal_policy(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
).- Parameters:
policy (
RemovalPolicy
) –- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str
Attributes
- authorization_type
The authorization type of this authorizer.
- authorizer_arn
The ARN of the authorizer to be used in permission policies, such as IAM and resource-based grants.
- authorizer_id
The id of the authorizer.
- env
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
The tree node.
- stack
The stack in which this resource is defined.
Static Methods
- classmethod is_authorizer(x)
Return whether the given object is an Authorizer.
- Parameters:
x (
Any
) –- Return type:
bool
- classmethod is_construct(x)
Checks if
x
is a construct.Use this method instead of
instanceof
to properly detectConstruct
instances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructs
library on disk are seen as independent, completely different libraries. As a consequence, the classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
the other class.npm install
will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, and using this type-testing method instead.- Parameters:
x (
Any
) – Any object.- Return type:
bool
- Returns:
true if
x
is an object created from a class which extendsConstruct
.
- classmethod is_owned_resource(construct)
Returns true if the construct was created by CDK, and false otherwise.
- Parameters:
construct (
IConstruct
) –- Return type:
bool
- classmethod is_resource(construct)
Check whether the given construct is a Resource.
- Parameters:
construct (
IConstruct
) –- Return type:
bool