Package software.amazon.awscdk.services.apigatewayv2.authorizers

Interface HttpUserPoolAuthorizerProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

HttpUserPoolAuthorizerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:46.891Z")
@Stability(Experimental)
public interface HttpUserPoolAuthorizerProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties to initialize HttpUserPoolAuthorizer.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigatewayv2.authorizers.*;
 import software.amazon.awscdk.services.cognito.*;
 UserPoolClient userPoolClient;
 HttpUserPoolAuthorizerProps httpUserPoolAuthorizerProps = HttpUserPoolAuthorizerProps.builder()
         .authorizerName("authorizerName")
         .identitySource(List.of("identitySource"))
         .userPoolClients(List.of(userPoolClient))
         .userPoolRegion("userPoolRegion")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	HttpUserPoolAuthorizerProps.Builder	A builder for HttpUserPoolAuthorizerProps
static final class	HttpUserPoolAuthorizerProps.Jsii$Proxy	An implementation for HttpUserPoolAuthorizerProps

Method Summary

Modifier and Type	Method	Description
static HttpUserPoolAuthorizerProps.Builder	builder()
default String	getAuthorizerName()	(experimental) Friendly name of the authorizer.
default List<String>	getIdentitySource()	(experimental) The identity source for which authorization is requested.
default List<IUserPoolClient>	getUserPoolClients()	(experimental) The user pool clients that should be used to authorize requests with the user pool.
default String	getUserPoolRegion()	(experimental) The AWS region in which the user pool is present.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAuthorizerName

@Stability(Experimental)
@Nullable
default String getAuthorizerName()

(experimental) Friendly name of the authorizer.

Default: - same value as `id` passed in the constructor

getIdentitySource

@Stability(Experimental)
@Nullable
default List<String> getIdentitySource()

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

Default: ['$request.header.Authorization']

getUserPoolClients

@Stability(Experimental)
@Nullable
default List<IUserPoolClient> getUserPoolClients()

(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

getUserPoolRegion

@Stability(Experimental)
@Nullable
default String getUserPoolRegion()

(experimental) The AWS region in which the user pool is present.

Default: - same region as the Route the authorizer is attached to.

builder

@Stability(Experimental)
static HttpUserPoolAuthorizerProps.Builder builder()

Returns:

a HttpUserPoolAuthorizerProps.Builder of HttpUserPoolAuthorizerProps