Package software.amazon.awscdk.services.apigateway

Class Authorizer

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.apigateway.Authorizer

All Implemented Interfaces:

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

Direct Known Subclasses:

CognitoUserPoolsAuthorizer, RequestAuthorizer, TokenAuthorizer

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:44.702Z")
@Stability(Stable)
public abstract class Authorizer
extends Resource
implements IAuthorizer

Base class for all custom authorizers.

Nested Class Summary

Nested classes/interfaces inherited from class software.constructs.Construct

software.constructs.Construct.Builder

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.apigateway.IAuthorizer

IAuthorizer.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

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

software.constructs.IConstruct.Jsii$Default

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

IResource.Jsii$Default

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
AuthorizationType	getAuthorizationType()	The authorization type of this authorizer.
abstract String	getAuthorizerId()	The authorizer ID.
static Boolean	isAuthorizer(Object x)	Return whether the given object is an 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.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

Authorizer

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

Authorizer

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

Authorizer

@Stability(Stable)
protected Authorizer(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 ResourceProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

Authorizer

@Stability(Stable)
protected Authorizer(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Details

isAuthorizer

@Stability(Stable)
@NotNull
public static Boolean isAuthorizer(@NotNull
 Object x)

Return whether the given object is an Authorizer.

Parameters:

x - This parameter is required.

getAuthorizerId

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

The authorizer ID.

Specified by:

getAuthorizerId in interface IAuthorizer

getAuthorizationType

@Stability(Stable)
@Nullable
public AuthorizationType getAuthorizationType()

The authorization type of this authorizer.

Specified by:

getAuthorizationType in interface IAuthorizer