Class: AWSCDK::Cognito::CfnUserPool::UserPoolAddOnsProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Cognito::CfnUserPool::UserPoolAddOnsProperty

Defined in:

cognito/cfn_user_pool.rb

Overview

User pool add-ons.

Contains settings for activation of threat protection. To log user security information but take no action, set to AUDIT . To configure automatic security responses to risky traffic to your user pool, set to ENFORCED .

For more information, see Adding advanced security to a user pool . To activate this setting, your user pool must be on the Plus tier .

See Also:

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

Instance Attribute Summary

• #advanced_security_additional_flows ⇒ AWSCDK::IResolvable, ... readonly

  Threat protection configuration options for additional authentication types in your user pool, including custom authentication.

• #advanced_security_mode ⇒ String^? readonly

  The operating mode of threat protection for standard authentication types in your user pool, including username-password and secure remote password (SRP) authentication.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(advanced_security_additional_flows: nil, advanced_security_mode: nil) ⇒ UserPoolAddOnsProperty constructor

  A new instance of UserPoolAddOnsProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(advanced_security_additional_flows: nil, advanced_security_mode: nil) ⇒ UserPoolAddOnsProperty

Returns a new instance of UserPoolAddOnsProperty.

Parameters:

• advanced_security_additional_flows (AWSCDK::IResolvable, AWSCDK::Cognito::CfnUserPool::AdvancedSecurityAdditionalFlowsProperty, nil) (defaults to: nil) —

  Threat protection configuration options for additional authentication types in your user pool, including custom authentication.

• advanced_security_mode (String, nil) (defaults to: nil) —

  The operating mode of threat protection for standard authentication types in your user pool, including username-password and secure remote password (SRP) authentication.

# File 'cognito/cfn_user_pool.rb', line 2207

def initialize(advanced_security_additional_flows: nil, advanced_security_mode: nil)
  @advanced_security_additional_flows = advanced_security_additional_flows.is_a?(Hash) ? ::AWSCDK::Cognito::CfnUserPool::AdvancedSecurityAdditionalFlowsProperty.new(**advanced_security_additional_flows.transform_keys(&:to_sym)) : advanced_security_additional_flows
  Jsii::Type.check_type(@advanced_security_additional_flows, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2duaXRvLkNmblVzZXJQb29sLkFkdmFuY2VkU2VjdXJpdHlBZGRpdGlvbmFsRmxvd3NQcm9wZXJ0eSJ9XX19")), "advancedSecurityAdditionalFlows") unless @advanced_security_additional_flows.nil?
  @advanced_security_mode = advanced_security_mode
  Jsii::Type.check_type(@advanced_security_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "advancedSecurityMode") unless @advanced_security_mode.nil?
end

Instance Attribute Details

#advanced_security_additional_flows ⇒ AWSCDK::IResolvable, ... (readonly)

Threat protection configuration options for additional authentication types in your user pool, including custom authentication.

Returns:

• (AWSCDK::IResolvable, AWSCDK::Cognito::CfnUserPool::AdvancedSecurityAdditionalFlowsProperty, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-userpooladdons.html#cfn-cognito-userpool-userpooladdons-advancedsecurityadditionalflows

# File 'cognito/cfn_user_pool.rb', line 2218

def advanced_security_additional_flows
  @advanced_security_additional_flows
end

#advanced_security_mode ⇒ String^? (readonly)

The operating mode of threat protection for standard authentication types in your user pool, including username-password and secure remote password (SRP) authentication.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-userpooladdons.html#cfn-cognito-userpool-userpooladdons-advancedsecuritymode

# File 'cognito/cfn_user_pool.rb', line 2223

def advanced_security_mode
  @advanced_security_mode
end

Class Method Details

.jsii_properties ⇒ Object

# File 'cognito/cfn_user_pool.rb', line 2225

def self.jsii_properties
  {
    :advanced_security_additional_flows => "advancedSecurityAdditionalFlows",
    :advanced_security_mode => "advancedSecurityMode",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'cognito/cfn_user_pool.rb', line 2232

def to_jsii
  result = {}
  result.merge!({
    "advancedSecurityAdditionalFlows" => @advanced_security_additional_flows,
    "advancedSecurityMode" => @advanced_security_mode,
  })
  result.compact
end