software.amazon.awscdk.services.apigatewayv2.authorizers

Interface UserPoolAuthorizerProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

UserPoolAuthorizerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.26.0 (build 7d76e02)",
           date="2021-03-25T11:29:21.448Z")
 @Stability(value=Experimental)
public interface UserPoolAuthorizerProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties to initialize UserPoolAuthorizer.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static UserPoolAuthorizerProps.Builder	builder()
default String	getAuthorizerName() (experimental) The name of the authorizer.
default List<String>	getIdentitySource() (experimental) The identity source for which authorization is requested.
IUserPool	getUserPool() (experimental) The associated user pool.
IUserPoolClient	getUserPoolClient() (experimental) The user pool client 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 Detail

getUserPool

@Stability(value=Experimental)
 @NotNull
IUserPool getUserPool()

(experimental) The associated user pool.

getUserPoolClient

@Stability(value=Experimental)
 @NotNull
IUserPoolClient getUserPoolClient()

(experimental) The user pool client that should be used to authorize requests with the user pool.

getAuthorizerName

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

(experimental) The name of the authorizer.

Default: 'UserPoolAuthorizer'

getIdentitySource

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

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

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

getUserPoolRegion

@Stability(value=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(value=Experimental)
static UserPoolAuthorizerProps.Builder builder()

Returns:

a UserPoolAuthorizerProps.Builder of UserPoolAuthorizerProps