software.amazon.awscdk.services.apigatewayv2.authorizers

Class HttpUserPoolAuthorizer

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.apigatewayv2.authorizers.HttpUserPoolAuthorizer

All Implemented Interfaces:

IHttpRouteAuthorizer, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.70.0 (build 03c2f6f)",
           date="2022-11-01T13:16:41.681Z")
 @Stability(value=Experimental)
public class HttpUserPoolAuthorizer
extends software.amazon.jsii.JsiiObject
implements IHttpRouteAuthorizer

(experimental) Authorize Http Api routes on whether the requester is registered as part of an AWS Cognito user pool.

Example:

 import software.amazon.awscdk.core.*;
 import software.amazon.awscdk.services.apigatewayv2.authorizers.HttpUserPoolAuthorizer;
 import software.amazon.awscdk.services.apigatewayv2.integrations.HttpUrlIntegration;
 UserPool userPool = new UserPool(this, "UserPool");
 HttpUserPoolAuthorizer authorizer = new HttpUserPoolAuthorizer("BooksAuthorizer", userPool);
 HttpApi api = new HttpApi(this, "HttpApi");
 api.addRoutes(AddRoutesOptions.builder()
         .integration(new HttpUrlIntegration("BooksIntegration", "https://get-books-proxy.myproxy.internal"))
         .path("/books")
         .authorizer(authorizer)
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpUserPoolAuthorizer.Builder (experimental) A fluent builder for HttpUserPoolAuthorizer.

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.IHttpRouteAuthorizer

IHttpRouteAuthorizer.Jsii$Default, IHttpRouteAuthorizer.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HttpUserPoolAuthorizer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	HttpUserPoolAuthorizer(software.amazon.jsii.JsiiObjectRef objRef)
	HttpUserPoolAuthorizer(String id, IUserPool pool) (experimental) Initialize a Cognito user pool authorizer to be bound with HTTP route.
	HttpUserPoolAuthorizer(String id, IUserPool pool, HttpUserPoolAuthorizerProps props) (experimental) Initialize a Cognito user pool authorizer to be bound with HTTP route.

Method Summary

Modifier and Type	Method and Description
HttpRouteAuthorizerConfig	bind(HttpRouteAuthorizerBindOptions options) (experimental) Bind this authorizer to a specified Http route.

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

HttpUserPoolAuthorizer

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

HttpUserPoolAuthorizer

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

HttpUserPoolAuthorizer

@Stability(value=Experimental)
public HttpUserPoolAuthorizer(@NotNull
                                                             String id,
                                                             @NotNull
                                                             IUserPool pool,
                                                             @Nullable
                                                             HttpUserPoolAuthorizerProps props)

(experimental) Initialize a Cognito user pool authorizer to be bound with HTTP route.

Parameters:

id - The id of the underlying construct. This parameter is required.

pool - The user pool to use for authorization. This parameter is required.

props - Properties to configure the authorizer.

HttpUserPoolAuthorizer

@Stability(value=Experimental)
public HttpUserPoolAuthorizer(@NotNull
                                                             String id,
                                                             @NotNull
                                                             IUserPool pool)

(experimental) Initialize a Cognito user pool authorizer to be bound with HTTP route.

Parameters:

id - The id of the underlying construct. This parameter is required.

pool - The user pool to use for authorization. This parameter is required.

Method Detail

bind

@Stability(value=Experimental)
 @NotNull
public HttpRouteAuthorizerConfig bind(@NotNull
                                                                               HttpRouteAuthorizerBindOptions options)

(experimental) Bind this authorizer to a specified Http route.

Specified by:

bind in interface IHttpRouteAuthorizer

Parameters:

options - This parameter is required.