Interface CfnListener.AuthenticateCognitoConfigProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnListener.AuthenticateCognitoConfigProperty extends
Specifies information required when integrating with Amazon Cognito to authenticate users.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 AuthenticateCognitoConfigProperty authenticateCognitoConfigProperty = AuthenticateCognitoConfigProperty.builder()
         // the properties below are optional
                 "authenticationRequestExtraParamsKey", "authenticationRequestExtraParams"))
  • Method Details

    • getUserPoolArn

      @Stability(Stable) @NotNull String getUserPoolArn()
      The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
    • getUserPoolClientId

      @Stability(Stable) @NotNull String getUserPoolClientId()
      The ID of the Amazon Cognito user pool client.
    • getUserPoolDomain

      @Stability(Stable) @NotNull String getUserPoolDomain()
      The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.
    • getAuthenticationRequestExtraParams

      @Stability(Stable) @Nullable default Object getAuthenticationRequestExtraParams()
      The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
    • getOnUnauthenticatedRequest

      @Stability(Stable) @Nullable default String getOnUnauthenticatedRequest()
      The behavior if the user is not authenticated. The following are possible values:.

      • deny `` - Return an HTTP 401 Unauthorized error.
      • allow `` - Allow the request to be forwarded to the target.
      • authenticate `` - Redirect the request to the IdP authorization endpoint. This is the default value.
    • getScope

      @Stability(Stable) @Nullable default String getScope()
      The set of user claims to be requested from the IdP. The default is openid .

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

    • getSessionCookieName

      @Stability(Stable) @Nullable default String getSessionCookieName()
      The name of the cookie used to maintain session information.

      The default is AWSELBAuthSessionCookie.

    • getSessionTimeout

      @Stability(Stable) @Nullable default String getSessionTimeout()
      The maximum duration of the authentication session, in seconds.

      The default is 604800 seconds (7 days).

    • builder

      @Stability(Stable) static CfnListener.AuthenticateCognitoConfigProperty.Builder builder()
      a CfnListener.AuthenticateCognitoConfigProperty.Builder of CfnListener.AuthenticateCognitoConfigProperty