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	build()
static HttpAuthorizer.Builder	create(software.constructs.Construct scope, String id)
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	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

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

build

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

Specified by:

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