AuthenticateCognitoActionConfig ¶

class AuthenticateCognitoActionConfig(TypedDict, closed=True):
    user_pool_arn: NotRequired[
        "capo_elastic_load_balancing_v2.types.authenticate_cognito_action_user_pool_arn.AuthenticateCognitoActionUserPoolArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the Amazon Cognito user pool.</p>"""
    user_pool_client_id: NotRequired[
        "capo_elastic_load_balancing_v2.types.authenticate_cognito_action_user_pool_client_id.AuthenticateCognitoActionUserPoolClientId"
    ]
    """<p>The ID of the Amazon Cognito user pool client.</p>"""
    user_pool_domain: NotRequired[
        "capo_elastic_load_balancing_v2.types.authenticate_cognito_action_user_pool_domain.AuthenticateCognitoActionUserPoolDomain"
    ]
    """<p>The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.</p>"""
    session_cookie_name: NotRequired[
        "capo_elastic_load_balancing_v2.types.authenticate_cognito_action_session_cookie_name.AuthenticateCognitoActionSessionCookieName"
    ]
    """<p>The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.</p>"""
    scope: NotRequired[
        "capo_elastic_load_balancing_v2.types.authenticate_cognito_action_scope.AuthenticateCognitoActionScope"
    ]
    """<p>The set of user claims to be requested from the IdP. The default is <code>openid</code>.</p> <p>To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.</p>"""
    session_timeout: NotRequired[
        "capo_elastic_load_balancing_v2.types.authenticate_cognito_action_session_timeout.AuthenticateCognitoActionSessionTimeout"
    ]
    """<p>The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).</p>"""
    authentication_request_extra_params: NotRequired[
        "capo_elastic_load_balancing_v2.types.authenticate_cognito_action_authentication_request_extra_params.AuthenticateCognitoActionAuthenticationRequestExtraParams"
    ]
    """<p>The query parameters (up to 10) to include in the redirect request to the authorization endpoint.</p>"""
    on_unauthenticated_request: NotRequired[
        "capo_elastic_load_balancing_v2.types.authenticate_cognito_action_conditional_behavior_enum.AuthenticateCognitoActionConditionalBehaviorEnum"
    ]
    """<p>The behavior if the user is not authenticated. The following are possible values:</p> <ul> <li> <p>deny<code></code> - Return an HTTP 401 Unauthorized error.</p> </li> <li> <p>allow<code></code> - Allow the request to be forwarded to the target.</p> </li> <li> <p>authenticate<code></code> - Redirect the request to the IdP authorization endpoint. This is the default value.</p> </li> </ul>"""