Interface CognitoUserPoolsAuthorizerProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CognitoUserPoolsAuthorizerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:44.925Z") @Stability(Stable) public interface CognitoUserPoolsAuthorizerProps extends software.amazon.jsii.JsiiSerializable
Properties for CognitoUserPoolsAuthorizer.

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());
 
  • Method Details

    • getCognitoUserPools

      @Stability(Stable) @NotNull List<IUserPool> getCognitoUserPools()
      The user pools to associate with this authorizer.
    • getAuthorizerName

      @Stability(Stable) @Nullable default String getAuthorizerName()
      An optional human friendly name for the authorizer.

      Note that, this is not the primary identifier of the authorizer.

      Default: - the unique construct ID

    • getIdentitySource

      @Stability(Stable) @Nullable default String getIdentitySource()
      The request header mapping expression for the bearer token.

      This is typically passed as part of the header, in which case this should be method.request.header.Authorizer where Authorizer is the header containing the bearer token.

      Default: `IdentitySource.header('Authorization')`

      See Also:
    • getResultsCacheTtl

      @Stability(Stable) @Nullable default Duration getResultsCacheTtl()
      How long APIGateway should cache the results.

      Max 1 hour. Disable caching by setting this to 0.

      Default: Duration.minutes(5)

    • builder

      @Stability(Stable) static CognitoUserPoolsAuthorizerProps.Builder builder()
      Returns:
      a CognitoUserPoolsAuthorizerProps.Builder of CognitoUserPoolsAuthorizerProps