software.amazon.awscdk.services.apigatewayv2

Interface HttpAuthorizerProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

HttpAuthorizerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.26.0 (build 7d76e02)",
           date="2021-03-25T11:29:21.420Z")
 @Stability(value=Experimental)
public interface HttpAuthorizerProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties to initialize an instance of `HttpAuthorizer`.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	HttpAuthorizerProps.Builder A builder for HttpAuthorizerProps
static class	HttpAuthorizerProps.Jsii$Proxy An implementation for HttpAuthorizerProps

Method Summary

Modifier and Type	Method and Description
static HttpAuthorizerProps.Builder	builder()
default String	getAuthorizerName() (experimental) Name of the authorizer.
IHttpApi	getHttpApi() (experimental) HTTP Api to attach the authorizer to.
List<String>	getIdentitySource() (experimental) The identity source for which authorization is requested.
default List<String>	getJwtAudience() (experimental) A list of the intended recipients of the JWT.
default String	getJwtIssuer() (experimental) The base domain of the identity provider that issues JWT.
HttpAuthorizerType	getType() (experimental) The type of authorizer.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getHttpApi

@Stability(value=Experimental)
 @NotNull
IHttpApi getHttpApi()

(experimental) HTTP Api to attach the authorizer to.

getIdentitySource

@Stability(value=Experimental)
 @NotNull
List<String> getIdentitySource()

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

See Also:

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

getType

@Stability(value=Experimental)
 @NotNull
HttpAuthorizerType getType()

(experimental) The type of authorizer.

getAuthorizerName

@Stability(value=Experimental)
 @Nullable
default String getAuthorizerName()

(experimental) Name of the authorizer.

Default: - id of the HttpAuthorizer construct.

getJwtAudience

@Stability(value=Experimental)
 @Nullable
default List<String> getJwtAudience()

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

getJwtIssuer

@Stability(value=Experimental)
 @Nullable
default String getJwtIssuer()

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

Default: - required for JWT authorizer types.

builder

@Stability(value=Experimental)
static HttpAuthorizerProps.Builder builder()

Returns:

a HttpAuthorizerProps.Builder of HttpAuthorizerProps