You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Note:

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

{
  user_pool_id: "UserPoolIdType", # required
  client_id: "ClientIdType",
  compromised_credentials_risk_configuration: {
    event_filter: ["SIGN_IN"], # accepts SIGN_IN, PASSWORD_CHANGE, SIGN_UP
    actions: { # required
      event_action: "BLOCK", # required, accepts BLOCK, NO_ACTION
    },
  },
  account_takeover_risk_configuration: {
    notify_configuration: {
      from: "StringType",
      reply_to: "StringType",
      source_arn: "ArnType", # required
      block_email: {
        subject: "EmailNotificationSubjectType", # required
        html_body: "EmailNotificationBodyType",
        text_body: "EmailNotificationBodyType",
      },
      no_action_email: {
        subject: "EmailNotificationSubjectType", # required
        html_body: "EmailNotificationBodyType",
        text_body: "EmailNotificationBodyType",
      },
      mfa_email: {
        subject: "EmailNotificationSubjectType", # required
        html_body: "EmailNotificationBodyType",
        text_body: "EmailNotificationBodyType",
      },
    },
    actions: { # required
      low_action: {
        notify: false, # required
        event_action: "BLOCK", # required, accepts BLOCK, MFA_IF_CONFIGURED, MFA_REQUIRED, NO_ACTION
      },
      medium_action: {
        notify: false, # required
        event_action: "BLOCK", # required, accepts BLOCK, MFA_IF_CONFIGURED, MFA_REQUIRED, NO_ACTION
      },
      high_action: {
        notify: false, # required
        event_action: "BLOCK", # required, accepts BLOCK, MFA_IF_CONFIGURED, MFA_REQUIRED, NO_ACTION
      },
    },
  },
  risk_exception_configuration: {
    blocked_ip_range_list: ["StringType"],
    skipped_ip_range_list: ["StringType"],
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#account_takeover_risk_configurationTypes::AccountTakeoverRiskConfigurationType

The account takeover risk configuration.



5870
5871
5872
5873
5874
5875
5876
5877
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5870

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

#client_idString

The app client ID. 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.

Otherwise, ClientId is mapped to the client. When the client ID is not null, the user pool configuration is overridden and the risk configuration for the client is used instead.

Returns:

  • (String)


5870
5871
5872
5873
5874
5875
5876
5877
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5870

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

#compromised_credentials_risk_configurationTypes::CompromisedCredentialsRiskConfigurationType

The compromised credentials risk configuration.



5870
5871
5872
5873
5874
5875
5876
5877
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5870

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

#risk_exception_configurationTypes::RiskExceptionConfigurationType

The configuration to override the risk decision.



5870
5871
5872
5873
5874
5875
5876
5877
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5870

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

#user_pool_idString

The user pool ID.

Returns:

  • (String)


5870
5871
5872
5873
5874
5875
5876
5877
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5870

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