Package software.amazon.awscdk.services.apigatewayv2

Class HttpAuthorizerProps.Builder

java.lang.Object

software.amazon.awscdk.services.apigatewayv2.HttpAuthorizerProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<HttpAuthorizerProps>

Enclosing interface:

HttpAuthorizerProps

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

A builder for HttpAuthorizerProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
HttpAuthorizerProps.Builder	authorizerName(String authorizerName)	Sets the value of HttpAuthorizerProps.getAuthorizerName()
HttpAuthorizerProps.Builder	authorizerUri(String authorizerUri)	Sets the value of HttpAuthorizerProps.getAuthorizerUri()
HttpAuthorizerProps	build()	Builds the configured instance.
HttpAuthorizerProps.Builder	enableSimpleResponses(Boolean enableSimpleResponses)	Sets the value of HttpAuthorizerProps.getEnableSimpleResponses()
HttpAuthorizerProps.Builder	httpApi(IHttpApi httpApi)	Sets the value of HttpAuthorizerProps.getHttpApi()
HttpAuthorizerProps.Builder	identitySource(List<String> identitySource)	Sets the value of HttpAuthorizerProps.getIdentitySource()
HttpAuthorizerProps.Builder	jwtAudience(List<String> jwtAudience)	Sets the value of HttpAuthorizerProps.getJwtAudience()
HttpAuthorizerProps.Builder	jwtIssuer(String jwtIssuer)	Sets the value of HttpAuthorizerProps.getJwtIssuer()
HttpAuthorizerProps.Builder	payloadFormatVersion(AuthorizerPayloadVersion payloadFormatVersion)	Sets the value of HttpAuthorizerProps.getPayloadFormatVersion()
HttpAuthorizerProps.Builder	resultsCacheTtl(Duration resultsCacheTtl)	Sets the value of HttpAuthorizerProps.getResultsCacheTtl()
HttpAuthorizerProps.Builder	type(HttpAuthorizerType type)	Sets the value of HttpAuthorizerProps.getType()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

httpApi

@Stability(Experimental)
public HttpAuthorizerProps.Builder httpApi(IHttpApi httpApi)

Sets the value of HttpAuthorizerProps.getHttpApi()

Parameters:

httpApi - HTTP Api to attach the authorizer to. This parameter is required.

Returns:

this

identitySource

@Stability(Experimental)
public HttpAuthorizerProps.Builder identitySource(List<String> identitySource)

Sets the value of HttpAuthorizerProps.getIdentitySource()

Parameters:

identitySource - The identity source for which authorization is requested. This parameter is required.

Returns:

this

type

@Stability(Experimental)
public HttpAuthorizerProps.Builder type(HttpAuthorizerType type)

Sets the value of HttpAuthorizerProps.getType()

Parameters:

type - The type of authorizer. This parameter is required.

Returns:

this

authorizerName

@Stability(Experimental)
public HttpAuthorizerProps.Builder authorizerName(String authorizerName)

Sets the value of HttpAuthorizerProps.getAuthorizerName()

Parameters:

authorizerName - Name of the authorizer.

Returns:

this

authorizerUri

@Stability(Experimental)
public HttpAuthorizerProps.Builder authorizerUri(String authorizerUri)

Sets the value of HttpAuthorizerProps.getAuthorizerUri()

Parameters:

authorizerUri - The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI.

Returns:

this

enableSimpleResponses

@Stability(Experimental)
public HttpAuthorizerProps.Builder enableSimpleResponses(Boolean enableSimpleResponses)

Sets the value of HttpAuthorizerProps.getEnableSimpleResponses()

Parameters:

enableSimpleResponses - Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy.

Returns:

this

jwtAudience

@Stability(Experimental)
public HttpAuthorizerProps.Builder jwtAudience(List<String> jwtAudience)

Sets the value of HttpAuthorizerProps.getJwtAudience()

Parameters:

jwtAudience - A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list.

Returns:

this

jwtIssuer

@Stability(Experimental)
public HttpAuthorizerProps.Builder jwtIssuer(String jwtIssuer)

Sets the value of HttpAuthorizerProps.getJwtIssuer()

Parameters:

jwtIssuer - The base domain of the identity provider that issues JWT.

Returns:

this

payloadFormatVersion

@Stability(Experimental)
public HttpAuthorizerProps.Builder payloadFormatVersion(AuthorizerPayloadVersion payloadFormatVersion)

Sets the value of HttpAuthorizerProps.getPayloadFormatVersion()

Parameters:

payloadFormatVersion - Specifies the format of the payload sent to an HTTP API Lambda authorizer.

Returns:

this

resultsCacheTtl

@Stability(Experimental)
public HttpAuthorizerProps.Builder resultsCacheTtl(Duration resultsCacheTtl)

Sets the value of HttpAuthorizerProps.getResultsCacheTtl()

Parameters:

resultsCacheTtl - How long APIGateway should cache the results. Max 1 hour.

Returns:

this

build

@Stability(Experimental)
public HttpAuthorizerProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of HttpAuthorizerProps

Throws:

NullPointerException - if any required attribute was not provided