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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb

Overview

Note:

When making an API call, you may pass AuthenticateCognitoActionConfig data as a hash:

{
  user_pool_arn: "AuthenticateCognitoActionUserPoolArn", # required
  user_pool_client_id: "AuthenticateCognitoActionUserPoolClientId", # required
  user_pool_domain: "AuthenticateCognitoActionUserPoolDomain", # required
  session_cookie_name: "AuthenticateCognitoActionSessionCookieName",
  scope: "AuthenticateCognitoActionScope",
  session_timeout: 1,
  authentication_request_extra_params: {
    "AuthenticateCognitoActionAuthenticationRequestParamName" => "AuthenticateCognitoActionAuthenticationRequestParamValue",
  },
  on_unauthenticated_request: "deny", # accepts deny, allow, authenticate
}

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_request_extra_paramsHash<String,String>

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

Returns:

  • (Hash<String,String>)


304
305
306
307
308
309
310
311
312
313
314
315
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 304

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_requestString

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)


304
305
306
307
308
309
310
311
312
313
314
315
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 304

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

#scopeString

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)


304
305
306
307
308
309
310
311
312
313
314
315
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 304

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

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

Returns:

  • (String)


304
305
306
307
308
309
310
311
312
313
314
315
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 304

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_timeoutInteger

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

Returns:

  • (Integer)


304
305
306
307
308
309
310
311
312
313
314
315
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 304

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_arnString

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

Returns:

  • (String)


304
305
306
307
308
309
310
311
312
313
314
315
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 304

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_idString

The ID of the Amazon Cognito user pool client.

Returns:

  • (String)


304
305
306
307
308
309
310
311
312
313
314
315
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 304

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_domainString

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

Returns:

  • (String)


304
305
306
307
308
309
310
311
312
313
314
315
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 304

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