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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing SetRiskConfigurationRequest as input to an Aws::Client method, you can use a vanilla 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"],
  },
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#account_takeover_risk_configuration ⇒ Types::AccountTakeoverRiskConfigurationType

The account takeover risk configuration.

Returns:

#client_id ⇒ String

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) —

    The app client ID.

#compromised_credentials_risk_configuration ⇒ Types::CompromisedCredentialsRiskConfigurationType

The compromised credentials risk configuration.

Returns:

#risk_exception_configuration ⇒ Types::RiskExceptionConfigurationType

The configuration to override the risk decision.

Returns:

#user_pool_id ⇒ String

The user pool ID.

Returns:

  • (String) —

    The user pool ID.