WebSocketAuthorizer

class aws_cdk.aws_apigatewayv2.WebSocketAuthorizer(scope, id, *, identity_source, type, web_socket_api, authorizer_name=None, authorizer_uri=None)

Bases: Resource

An authorizer for WebSocket Apis.

Resource:: AWS::ApiGatewayV2::Authorizer
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_apigatewayv2 as apigatewayv2

# web_socket_api: apigatewayv2.WebSocketApi

web_socket_authorizer = apigatewayv2.WebSocketAuthorizer(self, "MyWebSocketAuthorizer",
    identity_source=["identitySource"],
    type=apigatewayv2.WebSocketAuthorizerType.LAMBDA,
    web_socket_api=web_socket_api,

    # the properties below are optional
    authorizer_name="authorizerName",
    authorizer_uri="authorizerUri"
)

Parameters:

scope (Construct) –
id (str) –
identity_source (Sequence[str]) – The identity source for which authorization is requested.
type (WebSocketAuthorizerType) – The type of authorizer.
web_socket_api (IWebSocketApi) – WebSocket Api to attach the authorizer to.
authorizer_name (Optional[str]) – Name of the authorizer. Default: - id of the WebSocketAuthorizer construct.
authorizer_uri (Optional[str]) – The authorizer’s Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI. Default: - required for Request authorizer types

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

authorizer_id: 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 from_web_socket_authorizer_attributes(scope, id, *, authorizer_id, authorizer_type)

Import an existing WebSocket Authorizer into this CDK app.

Parameters:

scope (Construct) –
id (str) –
authorizer_id (str) – Id of the Authorizer.
authorizer_type (str) – Type of authorizer. Possible values are: - CUSTOM - Lambda Authorizer - NONE - No Authorization

Return type:

IWebSocketRouteAuthorizer

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct 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 class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof 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 the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, 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 extends Construct.

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