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

Inherits:

Struct

• Object
• Struct
• Aws::CognitoIdentityProvider::Types::RiskConfigurationType

Defined in:

gems/aws-sdk-cognitoidentityprovider/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 and SetRiskConfiguration.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:client_id]

Instance Attribute Summary

• #account_takeover_risk_configuration ⇒ Types::AccountTakeoverRiskConfigurationType

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

• #client_id ⇒ String

  The app client where this configuration is applied.

• #compromised_credentials_risk_configuration ⇒ Types::CompromisedCredentialsRiskConfigurationType

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

• #last_modified_date ⇒ Time

  The date and time when the item was modified.

• #risk_exception_configuration ⇒ Types::RiskExceptionConfigurationType

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

• #user_pool_id ⇒ String

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

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:

• (Types::AccountTakeoverRiskConfigurationType)

# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 9149

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)

# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 9149

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:

• (Types::CompromisedCredentialsRiskConfigurationType)

# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 9149

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)

# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 9149

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:

• (Types::RiskExceptionConfigurationType)

# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 9149

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)

# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 9149

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