HttpAuthorizerProps

class aws_cdk.aws_apigatewayv2.HttpAuthorizerProps(*, http_api, identity_source, type, authorizer_name=None, jwt_audience=None, jwt_issuer=None)

Bases: object

(experimental) Properties to initialize an instance of HttpAuthorizer.

Parameters
  • http_api (IHttpApi) – (experimental) HTTP Api to attach the authorizer to.

  • identity_source (Sequence[str]) – (experimental) The identity source for which authorization is requested.

  • type (HttpAuthorizerType) – (experimental) The type of authorizer.

  • authorizer_name (Optional[str]) – (experimental) Name of the authorizer. Default: - id of the HttpAuthorizer construct.

  • jwt_audience (Optional[Sequence[str]]) – (experimental) A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. Default: - required for JWT authorizer typess.

  • jwt_issuer (Optional[str]) – (experimental) The base domain of the identity provider that issues JWT. Default: - required for JWT authorizer types.

Stability

experimental

Attributes

authorizer_name

(experimental) Name of the authorizer.

Default
  • id of the HttpAuthorizer construct.

Stability

experimental

Return type

Optional[str]

http_api

(experimental) HTTP Api to attach the authorizer to.

Stability

experimental

Return type

IHttpApi

identity_source

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

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-identitysource

Stability

experimental

Return type

List[str]

jwt_audience

(experimental) A list of the intended recipients of the JWT.

A valid JWT must provide an aud that matches at least one entry in this list.

Default
  • required for JWT authorizer typess.

Stability

experimental

Return type

Optional[List[str]]

jwt_issuer

(experimental) The base domain of the identity provider that issues JWT.

Default
  • required for JWT authorizer types.

Stability

experimental

Return type

Optional[str]

type

(experimental) The type of authorizer.

Stability

experimental

Return type

HttpAuthorizerType