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

Inherits:

Struct

• Object
• Struct
• Aws::CognitoIdentityProvider::Types::SetRiskConfigurationRequest

Includes:

Structure

Defined in:

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"],
  },
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:client_id]

Instance Attribute Summary

• #account_takeover_risk_configuration ⇒ Types::AccountTakeoverRiskConfigurationType

  The account takeover risk configuration.

• #client_id ⇒ String

  The app client ID.

• #compromised_credentials_risk_configuration ⇒ Types::CompromisedCredentialsRiskConfigurationType

  The compromised credentials risk configuration.

• #risk_exception_configuration ⇒ Types::RiskExceptionConfigurationType

  The configuration to override the risk decision.

• #user_pool_id ⇒ String

  The user pool ID.

Instance Attribute Details

#account_takeover_risk_configuration ⇒ Types::AccountTakeoverRiskConfigurationType

The account takeover risk configuration.

Returns:

• (Types::AccountTakeoverRiskConfigurationType)

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

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 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 isn't null, the user pool configuration is overridden and the risk configuration for the client is used instead.

Returns:

• (String)

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

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 compromised credentials risk configuration.

Returns:

• (Types::CompromisedCredentialsRiskConfigurationType)

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

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

The configuration to override the risk decision.

Returns:

• (Types::RiskExceptionConfigurationType)

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

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 user pool ID.

Returns:

• (String)

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

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