HttpRouteAuthorizerConfig

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

Bases: object

(experimental) Results of binding an authorizer to an http route.

Parameters:

  • authorization_type (str) – (experimental) The type of authorization. Possible values are: - AWS_IAM - IAM Authorizer - JWT - JSON Web Token Authorizer - CUSTOM - Lambda Authorizer - NONE - No Authorization

  • authorization_scopes (Optional[Sequence[str]]) – (experimental) The list of OIDC scopes to include in the authorization. Default: - no authorization scopes

  • authorizer_id (Optional[str]) – (experimental) The authorizer id. Default: - No authorizer id (useful for AWS_IAM route authorizer)

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 as apigatewayv2

http_route_authorizer_config = apigatewayv2.HttpRouteAuthorizerConfig(
    authorization_type="authorizationType",

    # the properties below are optional
    authorization_scopes=["authorizationScopes"],
    authorizer_id="authorizerId"
)

Attributes

authorization_scopes

(experimental) The list of OIDC scopes to include in the authorization.

Default:

  • no authorization scopes

Stability:

experimental

authorization_type

(experimental) The type of authorization.

Possible values are:

  • AWS_IAM - IAM Authorizer

  • JWT - JSON Web Token Authorizer

  • CUSTOM - Lambda Authorizer

  • NONE - No Authorization

Stability:

experimental

authorizer_id

(experimental) The authorizer id.

Default:

  • No authorizer id (useful for AWS_IAM route authorizer)

Stability:

experimental