software.amazon.awscdk.services.apigatewayv2

Class HttpAuthorizer

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.apigatewayv2.HttpAuthorizer

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.70.0 (build 03c2f6f)",
           date="2022-11-01T13:16:41.560Z")
 @Stability(value=Experimental)
public class HttpAuthorizer
extends Resource
implements IHttpAuthorizer

(experimental) 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.core.*;
 import software.amazon.awscdk.services.apigatewayv2.*;
 Duration duration;
 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)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpAuthorizer.Builder (experimental) 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.amazon.awscdk.services.apigatewayv2.IHttpAuthorizer

IHttpAuthorizer.Jsii$Default, IHttpAuthorizer.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class software.amazon.awscdk.core.Resource

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

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.constructs.Construct

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.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

HttpAuthorizer

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

HttpAuthorizer

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

HttpAuthorizer

@Stability(value=Experimental)
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 Detail

fromHttpAuthorizerAttributes

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

(experimental) 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(value=Experimental)
 @NotNull
public String getAuthorizerId()

(experimental) Id of the Authorizer.

Specified by:

getAuthorizerId in interface IAuthorizer