software.amazon.awscdk.services.apigatewayv2.authorizers

Class HttpJwtAuthorizer.Builder

java.lang.Object

software.amazon.awscdk.services.apigatewayv2.authorizers.HttpJwtAuthorizer.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<HttpJwtAuthorizer>

Enclosing class:

HttpJwtAuthorizer

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

(experimental) A fluent builder for HttpJwtAuthorizer.

Method Summary

Modifier and Type	Method and Description
HttpJwtAuthorizer.Builder	authorizerName(String authorizerName) (experimental) The name of the authorizer.
HttpJwtAuthorizer	build()
static HttpJwtAuthorizer.Builder	create(String id, String jwtIssuer)
HttpJwtAuthorizer.Builder	identitySource(List<String> identitySource) (experimental) The identity source for which authorization is requested.
HttpJwtAuthorizer.Builder	jwtAudience(List<String> jwtAudience) (experimental) A list of the intended recipients of the JWT.

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 HttpJwtAuthorizer.Builder create(String id,
                                                                              String jwtIssuer)

Parameters:

id - The id of the underlying construct. This parameter is required.

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

Returns:

a new instance of HttpJwtAuthorizer.Builder.

jwtAudience

@Stability(value=Experimental)
public HttpJwtAuthorizer.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.

Parameters:

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

Returns:

this

authorizerName

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

(experimental) The name of the authorizer.

Default: - same value as `id` passed in the constructor

Parameters:

authorizerName - The name of the authorizer. This parameter is required.

Returns:

this

identitySource

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

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

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

Parameters:

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

Returns:

this

build

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

Specified by:

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