Class: AWSCDK::Cognito::CfnUserPool::DeviceConfigurationProperty

Inherits:

Jsii::Struct

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

Defined in:

cognito/cfn_user_pool.rb

Overview

The device-remembering configuration for a user pool.

See Also:

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

Instance Attribute Summary

• #challenge_required_on_new_device ⇒ Boolean, ... readonly

  When true, a remembered device can sign in with device authentication instead of SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA).

• #device_only_remembered_on_user_prompt ⇒ Boolean, ... readonly

  When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a ConfirmDevice API request.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(challenge_required_on_new_device: nil, device_only_remembered_on_user_prompt: nil) ⇒ DeviceConfigurationProperty constructor

  A new instance of DeviceConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(challenge_required_on_new_device: nil, device_only_remembered_on_user_prompt: nil) ⇒ DeviceConfigurationProperty

Returns a new instance of DeviceConfigurationProperty.

Parameters:

• challenge_required_on_new_device (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

  When true, a remembered device can sign in with device authentication instead of SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA).

• device_only_remembered_on_user_prompt (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

  When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a ConfirmDevice API request.

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

def initialize(challenge_required_on_new_device: nil, device_only_remembered_on_user_prompt: nil)
  @challenge_required_on_new_device = challenge_required_on_new_device
  Jsii::Type.check_type(@challenge_required_on_new_device, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "challengeRequiredOnNewDevice") unless @challenge_required_on_new_device.nil?
  @device_only_remembered_on_user_prompt = device_only_remembered_on_user_prompt
  Jsii::Type.check_type(@device_only_remembered_on_user_prompt, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "deviceOnlyRememberedOnUserPrompt") unless @device_only_remembered_on_user_prompt.nil?
end

Instance Attribute Details

#challenge_required_on_new_device ⇒ Boolean, ... (readonly)

When true, a remembered device can sign in with device authentication instead of SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA).

Whether or not ChallengeRequiredOnNewDevice is true, users who sign in with devices that have not been confirmed or remembered must still provide a second factor in a user pool that requires MFA.

Returns:

• (Boolean, AWSCDK::IResolvable, nil)

See Also:

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

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

def challenge_required_on_new_device
  @challenge_required_on_new_device
end

#device_only_remembered_on_user_prompt ⇒ Boolean, ... (readonly)

When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a ConfirmDevice API request.

In your app, create a prompt for your user to choose whether they want to remember their device. Return the user's choice in an UpdateDeviceStatus API request.

When DeviceOnlyRememberedOnUserPrompt is false , Amazon Cognito immediately remembers devices that you register in a ConfirmDevice API request.

Returns:

• (Boolean, AWSCDK::IResolvable, nil)

See Also:

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

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

def device_only_remembered_on_user_prompt
  @device_only_remembered_on_user_prompt
end

Class Method Details

.jsii_properties ⇒ Object

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

def self.jsii_properties
  {
    :challenge_required_on_new_device => "challengeRequiredOnNewDevice",
    :device_only_remembered_on_user_prompt => "deviceOnlyRememberedOnUserPrompt",
  }
end

Instance Method Details

#to_jsii ⇒ Object

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

def to_jsii
  result = {}
  result.merge!({
    "challengeRequiredOnNewDevice" => @challenge_required_on_new_device,
    "deviceOnlyRememberedOnUserPrompt" => @device_only_remembered_on_user_prompt,
  })
  result.compact
end