Package software.amazon.awscdk.services.apigatewayv2

Class HttpAuthorizer

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.apigatewayv2.HttpAuthorizer

All Implemented Interfaces:

IResource, IAuthorizer, IHttpAuthorizer, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:12.050Z")
@Stability(Stable)
public class HttpAuthorizer
extends Resource
implements IHttpAuthorizer

An authorizer for Http Apis.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.apigatewayv2.*;
 HttpApi httpApi;
 HttpAuthorizer httpAuthorizer = HttpAuthorizer.Builder.create(this, "MyHttpAuthorizer")
         .httpApi(httpApi)
         .identitySource(List.of("identitySource"))
         .type(HttpAuthorizerType.IAM)
         // the properties below are optional
         .authorizerName("authorizerName")
         .authorizerUri("authorizerUri")
         .enableSimpleResponses(false)
         .jwtAudience(List.of("jwtAudience"))
         .jwtIssuer("jwtIssuer")
         .payloadFormatVersion(AuthorizerPayloadVersion.VERSION_1_0)
         .resultsCacheTtl(Duration.minutes(30))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	HttpAuthorizer.Builder	A fluent builder for HttpAuthorizer.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigatewayv2.IHttpAuthorizer

IHttpAuthorizer.Jsii$Default, IHttpAuthorizer.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HttpAuthorizer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	HttpAuthorizer(software.amazon.jsii.JsiiObjectRef objRef)
	HttpAuthorizer(software.constructs.Construct scope, String id, HttpAuthorizerProps props)

Method Summary

Modifier and Type	Method	Description
static IHttpRouteAuthorizer	fromHttpAuthorizerAttributes(software.constructs.Construct scope, String id, HttpAuthorizerAttributes attrs)	Import an existing HTTP Authorizer into this CDK app.
String	getAuthorizerId()	Id of the Authorizer.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

HttpAuthorizer

protected HttpAuthorizer(software.amazon.jsii.JsiiObjectRef objRef)

HttpAuthorizer

protected HttpAuthorizer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

HttpAuthorizer

@Stability(Stable)
public HttpAuthorizer(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 HttpAuthorizerProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

fromHttpAuthorizerAttributes

@Stability(Stable)
@NotNull
public static IHttpRouteAuthorizer fromHttpAuthorizerAttributes(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 HttpAuthorizerAttributes attrs)

Import an existing HTTP Authorizer into this CDK app.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

getAuthorizerId

@Stability(Stable)
@NotNull
public String getAuthorizerId()

Id of the Authorizer.

Specified by:

getAuthorizerId in interface IAuthorizer