Class: AWSCDK::Cognito::CfnUserPool::PoliciesProperty

Inherits:

Jsii::Struct

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

Defined in:

cognito/cfn_user_pool.rb

Overview

A list of user pool policies.

Contains the policy that sets password-complexity requirements.

See Also:

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

Instance Attribute Summary

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

  The password policy settings for a user pool, including complexity, history, and length requirements.

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

  The policy for allowed types of authentication in a user pool.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(password_policy: nil, sign_in_policy: nil) ⇒ PoliciesProperty constructor

  A new instance of PoliciesProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(password_policy: nil, sign_in_policy: nil) ⇒ PoliciesProperty

Returns a new instance of PoliciesProperty.

Parameters:

• password_policy (AWSCDK::IResolvable, AWSCDK::Cognito::CfnUserPool::PasswordPolicyProperty, nil) (defaults to: nil) —

  The password policy settings for a user pool, including complexity, history, and length requirements.

• sign_in_policy (AWSCDK::IResolvable, AWSCDK::Cognito::CfnUserPool::SignInPolicyProperty, nil) (defaults to: nil) —

  The policy for allowed types of authentication in a user pool.

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

def initialize(password_policy: nil, sign_in_policy: nil)
  @password_policy = password_policy.is_a?(Hash) ? ::AWSCDK::Cognito::CfnUserPool::PasswordPolicyProperty.new(**password_policy.transform_keys(&:to_sym)) : password_policy
  Jsii::Type.check_type(@password_policy, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2duaXRvLkNmblVzZXJQb29sLlBhc3N3b3JkUG9saWN5UHJvcGVydHkifV19fQ==")), "passwordPolicy") unless @password_policy.nil?
  @sign_in_policy = sign_in_policy.is_a?(Hash) ? ::AWSCDK::Cognito::CfnUserPool::SignInPolicyProperty.new(**sign_in_policy.transform_keys(&:to_sym)) : sign_in_policy
  Jsii::Type.check_type(@sign_in_policy, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2duaXRvLkNmblVzZXJQb29sLlNpZ25JblBvbGljeVByb3BlcnR5In1dfX0=")), "signInPolicy") unless @sign_in_policy.nil?
end

Instance Attribute Details

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

The password policy settings for a user pool, including complexity, history, and length requirements.

Returns:

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

See Also:

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

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

def password_policy
  @password_policy
end

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

The policy for allowed types of authentication in a user pool.

To activate this setting, your user pool must be in the Essentials tier or higher.

Returns:

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

See Also:

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

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

def sign_in_policy
  @sign_in_policy
end

Class Method Details

.jsii_properties ⇒ Object

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

def self.jsii_properties
  {
    :password_policy => "passwordPolicy",
    :sign_in_policy => "signInPolicy",
  }
end

Instance Method Details

#to_jsii ⇒ Object

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

def to_jsii
  result = {}
  result.merge!({
    "passwordPolicy" => @password_policy,
    "signInPolicy" => @sign_in_policy,
  })
  result.compact
end