Class: Aws::CognitoIdentityProvider::Types::SetRiskConfigurationRequest

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

Overview

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 threat protection.

Returns:



9678
9679
9680
9681
9682
9683
9684
9685
9686
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 9678

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

#client_id ⇒ String

The ID of the app client where you want to set a risk configuration. If ‘ClientId` is null, then the risk configuration is mapped to `UserPoolId`. When the client ID is null, the same risk configuration is applied to all the clients in the userPool.

When you include a ‘ClientId` parameter, Amazon Cognito maps the configuration to the app client. When you include both `ClientId` and `UserPoolId`, Amazon Cognito maps the configuration to the app client only.

Returns:

  • (String) 


9678
9679
9680
9681
9682
9683
9684
9685
9686
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 9678

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

#compromised_credentials_risk_configuration ⇒ Types::CompromisedCredentialsRiskConfigurationType

The configuration of automated reactions to detected compromised credentials. Includes settings for blocking future sign-in requests and for the types of password-submission events you want to monitor.

Returns:



9678
9679
9680
9681
9682
9683
9684
9685
9686
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 9678

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

#risk_exception_configuration ⇒ Types::RiskExceptionConfigurationType

A set of IP-address overrides to threat protection. You can set up IP-address always-block and always-allow lists.

Returns:



9678
9679
9680
9681
9682
9683
9684
9685
9686
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 9678

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

#user_pool_id ⇒ String

The ID of the user pool where you want to set a risk configuration. If you include ‘UserPoolId` in your request, don’t include ‘ClientId`. When the client ID is null, the same risk configuration is applied to all the clients in the userPool. When you include both `ClientId` and `UserPoolId`, Amazon Cognito maps the configuration to the app client only.

Returns:

  • (String) 


9678
9679
9680
9681
9682
9683
9684
9685
9686
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 9678

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