software.amazon.awscdk.services.apigateway

Class CognitoUserPoolsAuthorizerProps.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.CognitoUserPoolsAuthorizerProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CognitoUserPoolsAuthorizerProps>

Enclosing interface:

CognitoUserPoolsAuthorizerProps

@Stability(value=Experimental)
public static final class CognitoUserPoolsAuthorizerProps.Builder
extends Object
implements software.amazon.jsii.Builder<CognitoUserPoolsAuthorizerProps>

A builder for CognitoUserPoolsAuthorizerProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CognitoUserPoolsAuthorizerProps.Builder	authorizerName(String authorizerName) Sets the value of CognitoUserPoolsAuthorizerProps.getAuthorizerName()
CognitoUserPoolsAuthorizerProps	build() Builds the configured instance.
CognitoUserPoolsAuthorizerProps.Builder	cognitoUserPools(List<? extends IUserPool> cognitoUserPools) Sets the value of CognitoUserPoolsAuthorizerProps.getCognitoUserPools()
CognitoUserPoolsAuthorizerProps.Builder	identitySource(String identitySource) Sets the value of CognitoUserPoolsAuthorizerProps.getIdentitySource()
CognitoUserPoolsAuthorizerProps.Builder	resultsCacheTtl(Duration resultsCacheTtl) Sets the value of CognitoUserPoolsAuthorizerProps.getResultsCacheTtl()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

cognitoUserPools

@Stability(value=Experimental)
public CognitoUserPoolsAuthorizerProps.Builder cognitoUserPools(List<? extends IUserPool> cognitoUserPools)

Sets the value of CognitoUserPoolsAuthorizerProps.getCognitoUserPools()

Parameters:

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

Returns:

this

authorizerName

@Stability(value=Experimental)
public CognitoUserPoolsAuthorizerProps.Builder authorizerName(String authorizerName)

Sets the value of CognitoUserPoolsAuthorizerProps.getAuthorizerName()

Parameters:

authorizerName - An optional human friendly name for the authorizer. Note that, this is not the primary identifier of the authorizer.

Returns:

this

identitySource

@Stability(value=Experimental)
public CognitoUserPoolsAuthorizerProps.Builder identitySource(String identitySource)

Sets the value of CognitoUserPoolsAuthorizerProps.getIdentitySource()

Parameters:

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.

Returns:

this

resultsCacheTtl

@Stability(value=Experimental)
public CognitoUserPoolsAuthorizerProps.Builder resultsCacheTtl(Duration resultsCacheTtl)

Sets the value of CognitoUserPoolsAuthorizerProps.getResultsCacheTtl()

Parameters:

resultsCacheTtl - How long APIGateway should cache the results. Max 1 hour. Disable caching by setting this to 0.

Returns:

this

build

@Stability(value=Experimental)
public CognitoUserPoolsAuthorizerProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CognitoUserPoolsAuthorizerProps

Throws:

NullPointerException - if any required attribute was not provided