Class: Aws::CognitoIdentityProvider::Types::RiskConfigurationType

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

The settings of risk configuration for threat protection with advanced security features in a user pool.

This data type is a response parameter of

DescribeRiskConfiguration][1

and [SetRiskConfiguration].

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeRiskConfiguration.html [2]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetRiskConfiguration.html

See Also:

Constant Summary collapse

SENSITIVE = 
[:client_id]

Instance Attribute Summary collapse

Instance Attribute Details

#account_takeover_risk_configuration ⇒ Types::AccountTakeoverRiskConfigurationType

The settings for automated responses and notification templates for adaptive authentication with advanced security features.

Returns:



9469
9470
9471
9472
9473
9474
9475
9476
9477
9478
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 9469

class RiskConfigurationType < Struct.new(
  :user_pool_id,
  :client_id,
  :compromised_credentials_risk_configuration,
  :account_takeover_risk_configuration,
  :risk_exception_configuration,
  :last_modified_date)
  SENSITIVE = [:client_id]
  include Aws::Structure
end

#client_id ⇒ String

The app client where this configuration is applied. When this parameter isn’t present, the risk configuration applies to all user pool app clients that don’t have client-level settings.

Returns:

  • (String) 


9469
9470
9471
9472
9473
9474
9475
9476
9477
9478
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 9469

class RiskConfigurationType < Struct.new(
  :user_pool_id,
  :client_id,
  :compromised_credentials_risk_configuration,
  :account_takeover_risk_configuration,
  :risk_exception_configuration,
  :last_modified_date)
  SENSITIVE = [:client_id]
  include Aws::Structure
end

#compromised_credentials_risk_configuration ⇒ Types::CompromisedCredentialsRiskConfigurationType

Settings for compromised-credentials actions and authentication types with advanced security features in full-function ‘ENFORCED` mode.

Returns:



9469
9470
9471
9472
9473
9474
9475
9476
9477
9478
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 9469

class RiskConfigurationType < Struct.new(
  :user_pool_id,
  :client_id,
  :compromised_credentials_risk_configuration,
  :account_takeover_risk_configuration,
  :risk_exception_configuration,
  :last_modified_date)
  SENSITIVE = [:client_id]
  include Aws::Structure
end

#last_modified_date ⇒ Time

The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java ‘Date` object.

Returns:

  • (Time) 


9469
9470
9471
9472
9473
9474
9475
9476
9477
9478
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 9469

class RiskConfigurationType < Struct.new(
  :user_pool_id,
  :client_id,
  :compromised_credentials_risk_configuration,
  :account_takeover_risk_configuration,
  :risk_exception_configuration,
  :last_modified_date)
  SENSITIVE = [:client_id]
  include Aws::Structure
end

#risk_exception_configuration ⇒ Types::RiskExceptionConfigurationType

Exceptions to the risk evaluation configuration, including always-allow and always-block IP address ranges.

Returns:



9469
9470
9471
9472
9473
9474
9475
9476
9477
9478
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 9469

class RiskConfigurationType < Struct.new(
  :user_pool_id,
  :client_id,
  :compromised_credentials_risk_configuration,
  :account_takeover_risk_configuration,
  :risk_exception_configuration,
  :last_modified_date)
  SENSITIVE = [:client_id]
  include Aws::Structure
end

#user_pool_id ⇒ String

The ID of the user pool that has the risk configuration applied.

Returns:

  • (String) 


9469
9470
9471
9472
9473
9474
9475
9476
9477
9478
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 9469

class RiskConfigurationType < Struct.new(
  :user_pool_id,
  :client_id,
  :compromised_credentials_risk_configuration,
  :account_takeover_risk_configuration,
  :risk_exception_configuration,
  :last_modified_date)
  SENSITIVE = [:client_id]
  include Aws::Structure
end