Package software.amazon.awscdk.services.apigateway

Class CognitoUserPoolsAuthorizer.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.CognitoUserPoolsAuthorizer.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CognitoUserPoolsAuthorizer>

Enclosing class:

CognitoUserPoolsAuthorizer

@Stability(Stable)
public static final class CognitoUserPoolsAuthorizer.Builder
extends Object
implements software.amazon.jsii.Builder<CognitoUserPoolsAuthorizer>

A fluent builder for CognitoUserPoolsAuthorizer.

Method Summary

Modifier and Type	Method	Description
CognitoUserPoolsAuthorizer.Builder	authorizerName(String authorizerName)	An optional human friendly name for the authorizer.
CognitoUserPoolsAuthorizer	build()
CognitoUserPoolsAuthorizer.Builder	cognitoUserPools(List<? extends IUserPool> cognitoUserPools)	The user pools to associate with this authorizer.
static CognitoUserPoolsAuthorizer.Builder	create(software.constructs.Construct scope, String id)
CognitoUserPoolsAuthorizer.Builder	identitySource(String identitySource)	The request header mapping expression for the bearer token.
CognitoUserPoolsAuthorizer.Builder	resultsCacheTtl(Duration resultsCacheTtl)	How long APIGateway should cache the results.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CognitoUserPoolsAuthorizer.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of CognitoUserPoolsAuthorizer.Builder.

cognitoUserPools

@Stability(Stable)
public CognitoUserPoolsAuthorizer.Builder cognitoUserPools(List<? extends IUserPool> cognitoUserPools)

The user pools to associate with this authorizer.

Parameters:

cognitoUserPools - The user pools to associate with this authorizer. This parameter is required.

Returns:

this

authorizerName

@Stability(Stable)
public CognitoUserPoolsAuthorizer.Builder authorizerName(String authorizerName)

An optional human friendly name for the authorizer.

Note that, this is not the primary identifier of the authorizer.

Default: - the unique construct ID

Parameters:

authorizerName - An optional human friendly name for the authorizer. This parameter is required.

Returns:

this

identitySource

@Stability(Stable)
public CognitoUserPoolsAuthorizer.Builder identitySource(String identitySource)

The request header mapping expression for the bearer token.

This is typically passed as part of the header, in which case this should be method.request.header.Authorizer where Authorizer is the header containing the bearer token.

Default: `IdentitySource.header('Authorization')`

Parameters:

identitySource - The request header mapping expression for the bearer token. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/apigateway/latest/api/API_CreateAuthorizer.html#apigw-CreateAuthorizer-request-identitySource

resultsCacheTtl

@Stability(Stable)
public CognitoUserPoolsAuthorizer.Builder resultsCacheTtl(Duration resultsCacheTtl)

How long APIGateway should cache the results.

Max 1 hour. Disable caching by setting this to 0.

Default: Duration.minutes(5)

Parameters:

resultsCacheTtl - How long APIGateway should cache the results. This parameter is required.

Returns:

this

build

@Stability(Stable)
public CognitoUserPoolsAuthorizer build()

Specified by:

build in interface software.amazon.jsii.Builder<CognitoUserPoolsAuthorizer>

Returns:

a newly built instance of CognitoUserPoolsAuthorizer.