WebSocketLambdaAuthorizerProps

class aws_cdk.aws_apigatewayv2_authorizers.WebSocketLambdaAuthorizerProps(*, authorizer_name=None, identity_source=None)

Bases: object

(experimental) Properties to initialize WebSocketTokenAuthorizer.

Parameters:

authorizer_name (Optional[str]) – (experimental) The name of the authorizer. Default: - same value as id passed in the constructor.
identity_source (Optional[Sequence[str]]) – (experimental) The identity source for which authorization is requested. Request parameter match 'route.request.querystring|header.[a-zA-z0-9._-]+'. Staged variable match 'stageVariables.[a-zA-Z0-9._-]+'. Context parameter match 'context.[a-zA-Z0-9._-]+'. Default: [‘route.request.header.Authorization’]

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

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

web_socket_lambda_authorizer_props = apigatewayv2_authorizers.WebSocketLambdaAuthorizerProps(
    authorizer_name="authorizerName",
    identity_source=["identitySource"]
)

Attributes

authorizer_name

(experimental) The name of the authorizer.

Default:

same value as id passed in the constructor.

Stability:

experimental

identity_source

(experimental) The identity source for which authorization is requested.

Request parameter match 'route.request.querystring|header.[a-zA-z0-9._-]+'. Staged variable match 'stageVariables.[a-zA-Z0-9._-]+'. Context parameter match 'context.[a-zA-Z0-9._-]+'.

Default:: [‘route.request.header.Authorization’]
Stability:: experimental