Package software.amazon.awscdk.services.apigatewayv2.authorizers

Class HttpUserPoolAuthorizer.Builder

java.lang.Object
software.amazon.awscdk.services.apigatewayv2.authorizers.HttpUserPoolAuthorizer.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<HttpUserPoolAuthorizer>
Enclosing class:
HttpUserPoolAuthorizer
@Stability(Experimental) public static final class HttpUserPoolAuthorizer.Builder extends Object implements software.amazon.jsii.Builder<HttpUserPoolAuthorizer>
(experimental) A fluent builder for HttpUserPoolAuthorizer.

  • Method Details

    • create

      @Stability(Experimental) public static HttpUserPoolAuthorizer.Builder create(String id, IUserPool pool)
      Parameters:
      id - The id of the underlying construct. This parameter is required.
      pool - The user pool to use for authorization. This parameter is required.
      Returns:
      a new instance of HttpUserPoolAuthorizer.Builder.

    • authorizerName

      @Stability(Experimental) public HttpUserPoolAuthorizer.Builder authorizerName(String authorizerName)
      (experimental) Friendly name of the authorizer.

      Default: - same value as `id` passed in the constructor

      Parameters:
      authorizerName - Friendly name of the authorizer. This parameter is required.
      Returns:
      this

    • identitySource

      @Stability(Experimental) public HttpUserPoolAuthorizer.Builder identitySource(List<String> identitySource)
      (experimental) The identity source for which authorization is requested.

      Default: ['$request.header.Authorization']

      Parameters:
      identitySource - The identity source for which authorization is requested. This parameter is required.
      Returns:
      this

    • userPoolClients

      @Stability(Experimental) public HttpUserPoolAuthorizer.Builder userPoolClients(List<? extends IUserPoolClient> userPoolClients)
      (experimental) The user pool clients that should be used to authorize requests with the user pool.

      Default: - a new client will be created for the given user pool

      Parameters:
      userPoolClients - The user pool clients that should be used to authorize requests with the user pool. This parameter is required.
      Returns:
      this

    • userPoolRegion

      @Stability(Experimental) public HttpUserPoolAuthorizer.Builder userPoolRegion(String userPoolRegion)
      (experimental) The AWS region in which the user pool is present.

      Default: - same region as the Route the authorizer is attached to.

      Parameters:
      userPoolRegion - The AWS region in which the user pool is present. This parameter is required.
      Returns:
      this

    • build

      @Stability(Experimental) public HttpUserPoolAuthorizer build()
      Specified by:
      build in interface software.amazon.jsii.Builder<HttpUserPoolAuthorizer>
      Returns:
      a newly built instance of HttpUserPoolAuthorizer.