WebSocketRouteAuthorizerConfig

class aws_cdk.aws_apigatewayv2.WebSocketRouteAuthorizerConfig(*, authorization_type, authorizer_id=None)

Bases: object

Results of binding an authorizer to an WebSocket route.

Parameters:

  • authorization_type (str) – The type of authorization. Possible values are: - CUSTOM - Lambda Authorizer - NONE - No Authorization

  • authorizer_id (Optional[str]) – The authorizer id. Default: - No authorizer id (useful for AWS_IAM route 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_route_authorizer_config = apigatewayv2.WebSocketRouteAuthorizerConfig(
    authorization_type="authorizationType",

    # the properties below are optional
    authorizer_id="authorizerId"
)

Attributes

authorization_type

The type of authorization.

Possible values are:

  • CUSTOM - Lambda Authorizer

  • NONE - No Authorization

authorizer_id

The authorizer id.

Default:

  • No authorizer id (useful for AWS_IAM route authorizer)