Class: AWSCDK::Cognito::CfnUserPoolRiskConfigurationAttachment::AccountTakeoverActionTypeProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Cognito::CfnUserPoolRiskConfigurationAttachment::AccountTakeoverActionTypeProperty

Defined in:

cognito/cfn_user_pool_risk_configuration_attachment.rb

Overview

The automated response to a risk level for adaptive authentication in full-function, or ENFORCED , mode.

You can assign an action to each risk level that advanced security features evaluates.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractiontype.html

Instance Attribute Summary

• #event_action ⇒ String readonly

  The action to take for the attempted account takeover action for the associated risk level.

• #notify ⇒ Boolean, AWSCDK::IResolvable readonly

  Determines whether Amazon Cognito sends a user a notification message when your user pools assesses a user's session at the associated risk level.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(event_action:, notify:) ⇒ AccountTakeoverActionTypeProperty constructor

  A new instance of AccountTakeoverActionTypeProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(event_action:, notify:) ⇒ AccountTakeoverActionTypeProperty

Returns a new instance of AccountTakeoverActionTypeProperty.

Parameters:

• event_action (String) —

  The action to take for the attempted account takeover action for the associated risk level.

• notify (Boolean, AWSCDK::IResolvable) —

  Determines whether Amazon Cognito sends a user a notification message when your user pools assesses a user's session at the associated risk level.

# File 'cognito/cfn_user_pool_risk_configuration_attachment.rb', line 552

def initialize(event_action:, notify:)
  @event_action = event_action
  Jsii::Type.check_type(@event_action, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "eventAction")
  @notify = notify
  Jsii::Type.check_type(@notify, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "notify")
end

Instance Attribute Details

#event_action ⇒ String (readonly)

The action to take for the attempted account takeover action for the associated risk level.

Valid values are as follows:

• BLOCK : Block the request.
• MFA_IF_CONFIGURED : Present an MFA challenge if possible. MFA is possible if the user pool has active MFA methods that the user can set up. For example, if the user pool only supports SMS message MFA but the user doesn't have a phone number attribute, MFA setup isn't possible. If MFA setup isn't possible, allow the request.
• MFA_REQUIRED : Present an MFA challenge if possible. Block the request if a user hasn't set up MFA. To sign in with required MFA, users must have an email address or phone number attribute, or a registered TOTP factor.
• NO_ACTION : Take no action. Permit sign-in.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractiontype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoveractiontype-eventaction

# File 'cognito/cfn_user_pool_risk_configuration_attachment.rb', line 570

def event_action
  @event_action
end

#notify ⇒ Boolean, AWSCDK::IResolvable (readonly)

Determines whether Amazon Cognito sends a user a notification message when your user pools assesses a user's session at the associated risk level.

Returns:

• (Boolean, AWSCDK::IResolvable)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolriskconfigurationattachment-accounttakeoveractiontype.html#cfn-cognito-userpoolriskconfigurationattachment-accounttakeoveractiontype-notify

# File 'cognito/cfn_user_pool_risk_configuration_attachment.rb', line 575

def notify
  @notify
end

Class Method Details

.jsii_properties ⇒ Object

# File 'cognito/cfn_user_pool_risk_configuration_attachment.rb', line 577

def self.jsii_properties
  {
    :event_action => "eventAction",
    :notify => "notify",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'cognito/cfn_user_pool_risk_configuration_attachment.rb', line 584

def to_jsii
  result = {}
  result.merge!({
    "eventAction" => @event_action,
    "notify" => @notify,
  })
  result.compact
end