AuthenticateCognitoActionProps

class aws_cdk.aws_elasticloadbalancingv2_actions.AuthenticateCognitoActionProps(*, next, user_pool, user_pool_client, user_pool_domain, authentication_request_extra_params=None, on_unauthenticated_request=None, scope=None, session_cookie_name=None, session_timeout=None)

Bases: object

Properties for AuthenticateCognitoAction.

Parameters
  • next (ListenerAction) – What action to execute next. Multiple actions form a linked chain; the chain must always terminate in a (weighted)forward, fixedResponse or redirect action.

  • user_pool (IUserPool) – The Amazon Cognito user pool.

  • user_pool_client (IUserPoolClient) – The Amazon Cognito user pool client.

  • user_pool_domain (IUserPoolDomain) – The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.

  • authentication_request_extra_params (Optional[Mapping[str, str]]) – The query parameters (up to 10) to include in the redirect request to the authorization endpoint. Default: - No extra parameters

  • on_unauthenticated_request (Optional[UnauthenticatedAction]) – The behavior if the user is not authenticated. Default: UnauthenticatedAction.AUTHENTICATE

  • scope (Optional[str]) – 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”

  • session_cookie_name (Optional[str]) – The name of the cookie used to maintain session information. Default: “AWSELBAuthSessionCookie”

  • session_timeout (Optional[Duration]) – The maximum duration of the authentication session. Default: Duration.days(7)

Attributes

authentication_request_extra_params

The query parameters (up to 10) to include in the redirect request to the authorization endpoint.

Default
  • No extra parameters

Return type

Optional[Mapping[str, str]]

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.

Return type

ListenerAction

on_unauthenticated_request

The behavior if the user is not authenticated.

Default

UnauthenticatedAction.AUTHENTICATE

Return type

Optional[UnauthenticatedAction]

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”

Return type

Optional[str]

The name of the cookie used to maintain session information.

Default

“AWSELBAuthSessionCookie”

Return type

Optional[str]

session_timeout

The maximum duration of the authentication session.

Default

Duration.days(7)

Return type

Optional[Duration]

user_pool

The Amazon Cognito user pool.

Return type

IUserPool

user_pool_client

The Amazon Cognito user pool client.

Return type

IUserPoolClient

user_pool_domain

The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.

Return type

IUserPoolDomain