Class CognitoUserPoolsAuthorizer
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.apigateway.Authorizer
software.amazon.awscdk.services.apigateway.CognitoUserPoolsAuthorizer
- All Implemented Interfaces:
IResource
,IAuthorizer
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-12-06T14:43:13.352Z")
@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
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCognitoUserPoolsAuthorizer
.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.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource
IResource.Jsii$Default
-
Constructor Summary
ModifierConstructorDescriptionprotected
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 TypeMethodDescriptionThe authorization type of this authorizer.The ARN of the authorizer to be used in permission policies, such as IAM and resource-based grants.The id of the authorizer.Methods inherited from class software.amazon.awscdk.services.apigateway.Authorizer
isAuthorizer
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.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
The ARN of the authorizer to be used in permission policies, such as IAM and resource-based grants. -
getAuthorizerId
The id of the authorizer.- Specified by:
getAuthorizerId
in interfaceIAuthorizer
- Specified by:
getAuthorizerId
in classAuthorizer
-
getAuthorizationType
The authorization type of this authorizer.- Specified by:
getAuthorizationType
in interfaceIAuthorizer
- Overrides:
getAuthorizationType
in classAuthorizer
-