software.amazon.awscdk.services.apigatewayv2

Class HttpAuthorizer.Builder

java.lang.Object

software.amazon.awscdk.services.apigatewayv2.HttpAuthorizer.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<HttpAuthorizer>

Enclosing class:

HttpAuthorizer

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

(experimental) A fluent builder for HttpAuthorizer.

Method Summary

Modifier and Type	Method and Description
HttpAuthorizer.Builder	authorizerName(String authorizerName) (experimental) Name of the authorizer.
HttpAuthorizer.Builder	authorizerUri(String authorizerUri) (experimental) The authorizer's Uniform Resource Identifier (URI).
HttpAuthorizer	build()
static HttpAuthorizer.Builder	create(software.constructs.Construct scope, String id)
HttpAuthorizer.Builder	enableSimpleResponses(Boolean enableSimpleResponses) (experimental) Specifies whether a Lambda authorizer returns a response in a simple format.
HttpAuthorizer.Builder	httpApi(IHttpApi httpApi) (experimental) HTTP Api to attach the authorizer to.
HttpAuthorizer.Builder	identitySource(List<String> identitySource) (experimental) The identity source for which authorization is requested.
HttpAuthorizer.Builder	jwtAudience(List<String> jwtAudience) (experimental) A list of the intended recipients of the JWT.
HttpAuthorizer.Builder	jwtIssuer(String jwtIssuer) (experimental) The base domain of the identity provider that issues JWT.
HttpAuthorizer.Builder	payloadFormatVersion(AuthorizerPayloadVersion payloadFormatVersion) (experimental) Specifies the format of the payload sent to an HTTP API Lambda authorizer.
HttpAuthorizer.Builder	resultsCacheTtl(Duration resultsCacheTtl) (experimental) How long APIGateway should cache the results.
HttpAuthorizer.Builder	type(HttpAuthorizerType type) (experimental) The type of authorizer.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static HttpAuthorizer.Builder create(software.constructs.Construct scope,
                                                                           String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of HttpAuthorizer.Builder.

httpApi

@Stability(value=Experimental)
public HttpAuthorizer.Builder httpApi(IHttpApi httpApi)

(experimental) HTTP Api to attach the authorizer to.

Parameters:

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

Returns:

this

identitySource

@Stability(value=Experimental)
public HttpAuthorizer.Builder identitySource(List<String> identitySource)

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

Parameters:

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

Returns:

this

See Also:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-identitysource

type

@Stability(value=Experimental)
public HttpAuthorizer.Builder type(HttpAuthorizerType type)

(experimental) The type of authorizer.

Parameters:

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

Returns:

this

authorizerName

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

(experimental) Name of the authorizer.

Default: - id of the HttpAuthorizer construct.

Parameters:

authorizerName - Name of the authorizer. This parameter is required.

Returns:

this

authorizerUri

@Stability(value=Experimental)
public HttpAuthorizer.Builder authorizerUri(String authorizerUri)

(experimental) The authorizer's Uniform Resource Identifier (URI).

For REQUEST authorizers, this must be a well-formed Lambda function URI.

Default: - required for Request authorizer types

Parameters:

authorizerUri - The authorizer's Uniform Resource Identifier (URI). This parameter is required.

Returns:

this

enableSimpleResponses

@Stability(value=Experimental)
public HttpAuthorizer.Builder enableSimpleResponses(Boolean enableSimpleResponses)

(experimental) 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.

Default: - The lambda authorizer must return an IAM policy as its response

Parameters:

enableSimpleResponses - Specifies whether a Lambda authorizer returns a response in a simple format. This parameter is required.

Returns:

this

jwtAudience

@Stability(value=Experimental)
public HttpAuthorizer.Builder jwtAudience(List<String> jwtAudience)

(experimental) 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.

Default: - required for JWT authorizer typess.

Parameters:

jwtAudience - A list of the intended recipients of the JWT. This parameter is required.

Returns:

this

jwtIssuer

@Stability(value=Experimental)
public HttpAuthorizer.Builder jwtIssuer(String jwtIssuer)

(experimental) The base domain of the identity provider that issues JWT.

Default: - required for JWT authorizer types.

Parameters:

jwtIssuer - The base domain of the identity provider that issues JWT. This parameter is required.

Returns:

this

payloadFormatVersion

@Stability(value=Experimental)
public HttpAuthorizer.Builder payloadFormatVersion(AuthorizerPayloadVersion payloadFormatVersion)

(experimental) Specifies the format of the payload sent to an HTTP API Lambda authorizer.

Default: AuthorizerPayloadVersion.VERSION_2_0 if the authorizer type is HttpAuthorizerType.LAMBDA

Parameters:

payloadFormatVersion - Specifies the format of the payload sent to an HTTP API Lambda authorizer. This parameter is required.

Returns:

this

resultsCacheTtl

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

(experimental) How long APIGateway should cache the results.

Max 1 hour.

Default: - API Gateway will not cache authorizer responses

Parameters:

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

Returns:

this

build

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

Specified by:

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