Class: Aws::ElasticLoadBalancingV2::Types::AuthenticateCognitoActionConfig

Inherits:

Struct

• Object
• Struct
• Aws::ElasticLoadBalancingV2::Types::AuthenticateCognitoActionConfig

Includes:

Structure

Defined in:

lib/aws-sdk-elasticloadbalancingv2/types.rb

Overview

Request parameters to use when integrating with Amazon Cognito to authenticate users.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #authentication_request_extra_params ⇒ Hash<String,String>

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

• #on_unauthenticated_request ⇒ String

  The behavior if the user is not authenticated.

• #scope ⇒ String

  The set of user claims to be requested from the IdP.

• #session_cookie_name ⇒ String

  The name of the cookie used to maintain session information.

• #session_timeout ⇒ Integer

  The maximum duration of the authentication session, in seconds.

• #user_pool_arn ⇒ String

  The Amazon Resource Name (ARN) of the Amazon Cognito user pool.

• #user_pool_client_id ⇒ String

  The ID of the Amazon Cognito user pool client.

• #user_pool_domain ⇒ String

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

Instance Attribute Details

#authentication_request_extra_params ⇒ Hash<String,String>

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

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-elasticloadbalancingv2/types.rb', line 273

class AuthenticateCognitoActionConfig < Struct.new(
  :user_pool_arn,
  :user_pool_client_id,
  :user_pool_domain,
  :session_cookie_name,
  :scope,
  :session_timeout,
  :authentication_request_extra_params,
  :on_unauthenticated_request)
  SENSITIVE = []
  include Aws::Structure
end

#on_unauthenticated_request ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-elasticloadbalancingv2/types.rb', line 273

class AuthenticateCognitoActionConfig < Struct.new(
  :user_pool_arn,
  :user_pool_client_id,
  :user_pool_domain,
  :session_cookie_name,
  :scope,
  :session_timeout,
  :authentication_request_extra_params,
  :on_unauthenticated_request)
  SENSITIVE = []
  include Aws::Structure
end

#scope ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-elasticloadbalancingv2/types.rb', line 273

class AuthenticateCognitoActionConfig < Struct.new(
  :user_pool_arn,
  :user_pool_client_id,
  :user_pool_domain,
  :session_cookie_name,
  :scope,
  :session_timeout,
  :authentication_request_extra_params,
  :on_unauthenticated_request)
  SENSITIVE = []
  include Aws::Structure
end

#session_cookie_name ⇒ String

The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.

Returns:

• (String)

# File 'lib/aws-sdk-elasticloadbalancingv2/types.rb', line 273

class AuthenticateCognitoActionConfig < Struct.new(
  :user_pool_arn,
  :user_pool_client_id,
  :user_pool_domain,
  :session_cookie_name,
  :scope,
  :session_timeout,
  :authentication_request_extra_params,
  :on_unauthenticated_request)
  SENSITIVE = []
  include Aws::Structure
end

#session_timeout ⇒ Integer

The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).

Returns:

• (Integer)

# File 'lib/aws-sdk-elasticloadbalancingv2/types.rb', line 273

class AuthenticateCognitoActionConfig < Struct.new(
  :user_pool_arn,
  :user_pool_client_id,
  :user_pool_domain,
  :session_cookie_name,
  :scope,
  :session_timeout,
  :authentication_request_extra_params,
  :on_unauthenticated_request)
  SENSITIVE = []
  include Aws::Structure
end

#user_pool_arn ⇒ String

The Amazon Resource Name (ARN) of the Amazon Cognito user pool.

Returns:

• (String)

# File 'lib/aws-sdk-elasticloadbalancingv2/types.rb', line 273

class AuthenticateCognitoActionConfig < Struct.new(
  :user_pool_arn,
  :user_pool_client_id,
  :user_pool_domain,
  :session_cookie_name,
  :scope,
  :session_timeout,
  :authentication_request_extra_params,
  :on_unauthenticated_request)
  SENSITIVE = []
  include Aws::Structure
end

#user_pool_client_id ⇒ String

The ID of the Amazon Cognito user pool client.

Returns:

• (String)

# File 'lib/aws-sdk-elasticloadbalancingv2/types.rb', line 273

class AuthenticateCognitoActionConfig < Struct.new(
  :user_pool_arn,
  :user_pool_client_id,
  :user_pool_domain,
  :session_cookie_name,
  :scope,
  :session_timeout,
  :authentication_request_extra_params,
  :on_unauthenticated_request)
  SENSITIVE = []
  include Aws::Structure
end

#user_pool_domain ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-elasticloadbalancingv2/types.rb', line 273

class AuthenticateCognitoActionConfig < Struct.new(
  :user_pool_arn,
  :user_pool_client_id,
  :user_pool_domain,
  :session_cookie_name,
  :scope,
  :session_timeout,
  :authentication_request_extra_params,
  :on_unauthenticated_request)
  SENSITIVE = []
  include Aws::Structure
end