Package software.amazon.awscdk.services.elasticloadbalancingv2.actions

Class AuthenticateCognitoAction.Builder

java.lang.Object
software.amazon.awscdk.services.elasticloadbalancingv2.actions.AuthenticateCognitoAction.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<AuthenticateCognitoAction>
Enclosing class:
AuthenticateCognitoAction
@Stability(Stable) public static final class AuthenticateCognitoAction.Builder extends Object implements software.amazon.jsii.Builder<AuthenticateCognitoAction>
A fluent builder for AuthenticateCognitoAction.

  • Method Details

    • create

      @Stability(Stable) public static AuthenticateCognitoAction.Builder create()
      Returns:
      a new instance of AuthenticateCognitoAction.Builder.

    • next

      @Stability(Stable) public AuthenticateCognitoAction.Builder next(ListenerAction next)
      What action to execute next.

      Multiple actions form a linked chain; the chain must always terminate in a (weighted)forward, fixedResponse or redirect action.

      Parameters:
      next - What action to execute next. This parameter is required.
      Returns:
      this

    • userPool

      @Stability(Stable) public AuthenticateCognitoAction.Builder userPool(IUserPool userPool)
      The Amazon Cognito user pool.

      Parameters:
      userPool - The Amazon Cognito user pool. This parameter is required.
      Returns:
      this

    • userPoolClient

      @Stability(Stable) public AuthenticateCognitoAction.Builder userPoolClient(IUserPoolClient userPoolClient)
      The Amazon Cognito user pool client.

      Parameters:
      userPoolClient - The Amazon Cognito user pool client. This parameter is required.
      Returns:
      this

    • userPoolDomain

      @Stability(Stable) public AuthenticateCognitoAction.Builder userPoolDomain(IUserPoolDomain userPoolDomain)
      The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.

      Parameters:
      userPoolDomain - The domain prefix or fully-qualified domain name of the Amazon Cognito user pool. This parameter is required.
      Returns:
      this

    • allowHttpsOutbound

      @Stability(Stable) public AuthenticateCognitoAction.Builder allowHttpsOutbound(Boolean allowHttpsOutbound)
      Allow HTTPS outbound traffic to communicate with the IdP.

      Set this property to false if the IP address used for the IdP endpoint is identifiable and you want to control outbound traffic. Then allow HTTPS outbound traffic to the IdP's IP address using the listener's connections property.

      Default: true

      Parameters:
      allowHttpsOutbound - Allow HTTPS outbound traffic to communicate with the IdP. This parameter is required.
      Returns:
      this
      See Also:

    • authenticationRequestExtraParams

      @Stability(Stable) public AuthenticateCognitoAction.Builder authenticationRequestExtraParams(Map<String,String> authenticationRequestExtraParams)
      The query parameters (up to 10) to include in the redirect request to the authorization endpoint.

      Default: - No extra parameters

      Parameters:
      authenticationRequestExtraParams - The query parameters (up to 10) to include in the redirect request to the authorization endpoint. This parameter is required.
      Returns:
      this

    • onUnauthenticatedRequest

      @Stability(Stable) public AuthenticateCognitoAction.Builder onUnauthenticatedRequest(UnauthenticatedAction onUnauthenticatedRequest)
      The behavior if the user is not authenticated.

      Default: UnauthenticatedAction.AUTHENTICATE

      Parameters:
      onUnauthenticatedRequest - The behavior if the user is not authenticated. This parameter is required.
      Returns:
      this

    • scope

      @Stability(Stable) public AuthenticateCognitoAction.Builder scope(String scope)
      The set of user claims to be requested from the IdP.

      To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.

      Default: "openid"

      Parameters:
      scope - The set of user claims to be requested from the IdP. This parameter is required.
      Returns:
      this

    • sessionCookieName

      @Stability(Stable) public AuthenticateCognitoAction.Builder sessionCookieName(String sessionCookieName)
      The name of the cookie used to maintain session information.

      Default: "AWSELBAuthSessionCookie"

      Parameters:
      sessionCookieName - The name of the cookie used to maintain session information. This parameter is required.
      Returns:
      this

    • sessionTimeout

      @Stability(Stable) public AuthenticateCognitoAction.Builder sessionTimeout(Duration sessionTimeout)
      The maximum duration of the authentication session.

      Default: Duration.days(7)

      Parameters:
      sessionTimeout - The maximum duration of the authentication session. This parameter is required.
      Returns:
      this

    • build

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