Package software.amazon.awscdk.services.apigateway

Class CognitoUserPoolsAuthorizer

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

software.amazon.awscdk.services.apigateway.CognitoUserPoolsAuthorizer

All Implemented Interfaces:

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

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

Cognito user pools based custom authorizer.

Example:

 Resource books;
 UserPool userPool = new UserPool(this, "UserPool");
 CognitoUserPoolsAuthorizer auth = CognitoUserPoolsAuthorizer.Builder.create(this, "booksAuthorizer")
         .cognitoUserPools(List.of(userPool))
         .build();
 books.addMethod("GET", new HttpIntegration("http://amazon.com"), MethodOptions.builder()
         .authorizer(auth)
         .authorizationType(AuthorizationType.COGNITO)
         .build());
 

Nested Class Summary

Nested Classes

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

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, IAuthorizer.Jsii$Proxy

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	CognitoUserPoolsAuthorizer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CognitoUserPoolsAuthorizer(software.amazon.jsii.JsiiObjectRef objRef)
	CognitoUserPoolsAuthorizer(software.constructs.Construct scope, String id, CognitoUserPoolsAuthorizerProps props)

Method Summary

Modifier and Type	Method	Description
AuthorizationType	getAuthorizationType()	The authorization type of this authorizer.
String	getAuthorizerArn()	The ARN of the authorizer to be used in permission policies, such as IAM and resource-based grants.
String	getAuthorizerId()	The id of the authorizer.

Methods inherited from class software.amazon.awscdk.services.apigateway.Authorizer

isAuthorizer

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

CognitoUserPoolsAuthorizer

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

CognitoUserPoolsAuthorizer

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

CognitoUserPoolsAuthorizer

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

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

getAuthorizerArn

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

The ARN of the authorizer to be used in permission policies, such as IAM and resource-based grants.

getAuthorizerId

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

The id of the authorizer.

Specified by:

getAuthorizerId in interface IAuthorizer

Specified by:

getAuthorizerId in class Authorizer

getAuthorizationType

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

The authorization type of this authorizer.

Specified by:

getAuthorizationType in interface IAuthorizer

Overrides:

getAuthorizationType in class Authorizer