HttpUserPoolAuthorizerProps
- class aws_cdk.aws_apigatewayv2_authorizers.HttpUserPoolAuthorizerProps(*, authorizer_name=None, identity_source=None, user_pool_clients=None, user_pool_region=None)
Bases:
object
(experimental) Properties to initialize HttpUserPoolAuthorizer.
- Parameters:
authorizer_name (
Optional
[str
]) – (experimental) Friendly name of the authorizer. Default: - same value asid
passed in the constructoridentity_source (
Optional
[Sequence
[str
]]) – (experimental) The identity source for which authorization is requested. Default: [‘$request.header.Authorization’]user_pool_clients (
Optional
[Sequence
[IUserPoolClient
]]) – (experimental) The user pool clients that should be used to authorize requests with the user pool. Default: - a new client will be created for the given user pooluser_pool_region (
Optional
[str
]) – (experimental) The AWS region in which the user pool is present. Default: - same region as the Route the authorizer is attached to.
- 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 import aws_cdk.aws_cognito as cognito # user_pool_client: cognito.UserPoolClient http_user_pool_authorizer_props = apigatewayv2_authorizers.HttpUserPoolAuthorizerProps( authorizer_name="authorizerName", identity_source=["identitySource"], user_pool_clients=[user_pool_client], user_pool_region="userPoolRegion" )
Attributes
- authorizer_name
(experimental) Friendly 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.
- Default:
[‘$request.header.Authorization’]
- Stability:
experimental
- user_pool_clients
(experimental) The user pool clients that should be used to authorize requests with the user pool.
- Default:
a new client will be created for the given user pool
- Stability:
experimental
- user_pool_region
(experimental) The AWS region in which the user pool is present.
- Default:
same region as the Route the authorizer is attached to.
- Stability:
experimental