Class: AWSCDK::Cognito::CfnUserPool

Inherits:
AWSCDK::CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSCognito::IUserPoolRef
Defined in:
cognito/cfn_user_pool.rb

Overview

The AWS::Cognito::UserPool resource creates an Amazon Cognito user pool.

For more information on working with Amazon Cognito user pools, see Amazon Cognito User Pools and CreateUserPool .

If you don't specify a value for a parameter, Amazon Cognito sets it to a default value.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ CfnUserPool

Create a new AWS::Cognito::UserPool.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::Cognito::CfnUserPoolProps, nil) (defaults to: nil) —

    Resource properties.



22
23
24
25
26
27
28
 
# File 'cognito/cfn_user_pool.rb', line 22

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::Cognito::CfnUserPoolProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0by5DZm5Vc2VyUG9vbFByb3BzIn0=")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_user_pool(resource) ⇒ String

Parameters:

Returns:

  • (String) 


108
109
110
111
 
# File 'cognito/cfn_user_pool.rb', line 108

def self.arn_for_user_pool(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19jb2duaXRvLklVc2VyUG9vbFJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cognito.CfnUserPool", "arnForUserPool", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


241
242
243
 
# File 'cognito/cfn_user_pool.rb', line 241

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.CfnUserPool", "CFN_RESOURCE_TYPE_NAME")
end

.from_user_pool_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSCognito::IUserPoolRef

Creates a new IUserPoolRef from an ARN.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • arn (String)

Returns:



119
120
121
122
123
124
 
# File 'cognito/cfn_user_pool.rb', line 119

def self.from_user_pool_arn(scope, id, arn)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cognito.CfnUserPool", "fromUserPoolArn", [scope, id, arn])
end

.from_user_pool_id(scope, id, user_pool_id) ⇒ AWSCDK::Interfaces::AWSCognito::IUserPoolRef

Creates a new IUserPoolRef from a userPoolId.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • user_pool_id (String)

Returns:



132
133
134
135
136
137
 
# File 'cognito/cfn_user_pool.rb', line 132

def self.from_user_pool_id(scope, id, user_pool_id)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(user_pool_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "userPoolId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cognito.CfnUserPool", "fromUserPoolId", [scope, id, user_pool_id])
end

.is_cfn_user_pool(x) ⇒ Boolean

Checks whether the given object is a CfnUserPool.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


143
144
145
146
 
# File 'cognito/cfn_user_pool.rb', line 143

def self.is_cfn_user_pool(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cognito.CfnUserPool", "isCfnUserPool", [x])
end

.jsii_overridable_methods ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'cognito/cfn_user_pool.rb', line 30

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_provider_name => { kind: :property, name: "attrProviderName", is_optional: false },
    :attr_provider_url => { kind: :property, name: "attrProviderUrl", is_optional: false },
    :attr_user_pool_id => { kind: :property, name: "attrUserPoolId", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :user_pool_ref => { kind: :property, name: "userPoolRef", is_optional: false },
    :user_pool_tags_raw => { kind: :property, name: "userPoolTagsRaw", is_optional: false },
    :account_recovery_setting => { kind: :property, name: "accountRecoverySetting", is_optional: true },
    :admin_create_user_config => { kind: :property, name: "adminCreateUserConfig", is_optional: true },
    :alias_attributes => { kind: :property, name: "aliasAttributes", is_optional: true },
    :auto_verified_attributes => { kind: :property, name: "autoVerifiedAttributes", is_optional: true },
    :deletion_protection => { kind: :property, name: "deletionProtection", is_optional: true },
    :device_configuration => { kind: :property, name: "deviceConfiguration", is_optional: true },
    :email_authentication_message => { kind: :property, name: "emailAuthenticationMessage", is_optional: true },
    :email_authentication_subject => { kind: :property, name: "emailAuthenticationSubject", is_optional: true },
    :email_configuration => { kind: :property, name: "emailConfiguration", is_optional: true },
    :email_verification_message => { kind: :property, name: "emailVerificationMessage", is_optional: true },
    :email_verification_subject => { kind: :property, name: "emailVerificationSubject", is_optional: true },
    :enabled_mfas => { kind: :property, name: "enabledMfas", is_optional: true },
    :lambda_config => { kind: :property, name: "lambdaConfig", is_optional: true },
    :mfa_configuration => { kind: :property, name: "mfaConfiguration", is_optional: true },
    :policies => { kind: :property, name: "policies", is_optional: true },
    :schema => { kind: :property, name: "schema", is_optional: true },
    :sms_authentication_message => { kind: :property, name: "smsAuthenticationMessage", is_optional: true },
    :sms_configuration => { kind: :property, name: "smsConfiguration", is_optional: true },
    :sms_verification_message => { kind: :property, name: "smsVerificationMessage", is_optional: true },
    :user_attribute_update_settings => { kind: :property, name: "userAttributeUpdateSettings", is_optional: true },
    :username_attributes => { kind: :property, name: "usernameAttributes", is_optional: true },
    :username_configuration => { kind: :property, name: "usernameConfiguration", is_optional: true },
    :user_pool_add_ons => { kind: :property, name: "userPoolAddOns", is_optional: true },
    :user_pool_name => { kind: :property, name: "userPoolName", is_optional: true },
    :user_pool_tier => { kind: :property, name: "userPoolTier", is_optional: true },
    :verification_message_template => { kind: :property, name: "verificationMessageTemplate", is_optional: true },
    :web_authn_factor_configuration => { kind: :property, name: "webAuthnFactorConfiguration", is_optional: true },
    :web_authn_relying_party_id => { kind: :property, name: "webAuthnRelyingPartyId", is_optional: true },
    :web_authn_user_verification => { kind: :property, name: "webAuthnUserVerification", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#account_recovery_setting ⇒ AWSCDK::IResolvable, ...

The available verified method a user can use to recover their password when they call ForgotPassword .

Returns:



302
303
304
 
# File 'cognito/cfn_user_pool.rb', line 302

def ()
  jsii_get_property("accountRecoverySetting")
end

#account_recovery_setting=(value) ⇒ Object 



306
307
308
309
310
 
# File 'cognito/cfn_user_pool.rb', line 306

def (value)
  value = value.is_a?(Hash) ? ::AWSCDK::Cognito::CfnUserPool::AccountRecoverySettingProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2duaXRvLkNmblVzZXJQb29sLkFjY291bnRSZWNvdmVyeVNldHRpbmdQcm9wZXJ0eSJ9XX19")), "accountRecoverySetting") unless value.nil?
  jsii_set_property("accountRecoverySetting", value)
end

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



688
689
690
691
 
# File 'cognito/cfn_user_pool.rb', line 688

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



700
701
702
703
 
# File 'cognito/cfn_user_pool.rb', line 700

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



710
711
712
713
 
# File 'cognito/cfn_user_pool.rb', line 710

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



721
722
723
724
725
 
# File 'cognito/cfn_user_pool.rb', line 721

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


778
779
780
781
782
 
# File 'cognito/cfn_user_pool.rb', line 778

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



788
789
790
791
 
# File 'cognito/cfn_user_pool.rb', line 788

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



800
801
802
803
804
 
# File 'cognito/cfn_user_pool.rb', line 800

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#admin_create_user_config ⇒ AWSCDK::IResolvable, ...

The settings for administrator creation of users in a user pool.

Returns:



315
316
317
 
# File 'cognito/cfn_user_pool.rb', line 315

def admin_create_user_config()
  jsii_get_property("adminCreateUserConfig")
end

#admin_create_user_config=(value) ⇒ Object 



319
320
321
322
323
 
# File 'cognito/cfn_user_pool.rb', line 319

def admin_create_user_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Cognito::CfnUserPool::AdminCreateUserConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2duaXRvLkNmblVzZXJQb29sLkFkbWluQ3JlYXRlVXNlckNvbmZpZ1Byb3BlcnR5In1dfX0=")), "adminCreateUserConfig") unless value.nil?
  jsii_set_property("adminCreateUserConfig", value)
end

#alias_attributes ⇒ Array<String>?

Attributes supported as an alias for this user pool.

Returns:

  • (Array<String>, nil) 


328
329
330
 
# File 'cognito/cfn_user_pool.rb', line 328

def alias_attributes()
  jsii_get_property("aliasAttributes")
end

#alias_attributes=(value) ⇒ Object 



332
333
334
335
 
# File 'cognito/cfn_user_pool.rb', line 332

def alias_attributes=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "aliasAttributes") unless value.nil?
  jsii_set_property("aliasAttributes", value)
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



813
814
815
816
 
# File 'cognito/cfn_user_pool.rb', line 813

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



835
836
837
838
839
840
 
# File 'cognito/cfn_user_pool.rb', line 835

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_arn ⇒ String

The Amazon Resource Name (ARN) of the user pool, such as arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341 .

Returns:

  • (String) 


248
249
250
 
# File 'cognito/cfn_user_pool.rb', line 248

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_provider_name ⇒ String

A friendly name for the IdP.

Returns:

  • (String) 


255
256
257
 
# File 'cognito/cfn_user_pool.rb', line 255

def attr_provider_name()
  jsii_get_property("attrProviderName")
end

#attr_provider_url ⇒ String

The URL of the provider of the Amazon Cognito user pool, specified as a String .

Returns:

  • (String) 


262
263
264
 
# File 'cognito/cfn_user_pool.rb', line 262

def attr_provider_url()
  jsii_get_property("attrProviderUrl")
end

#attr_user_pool_id ⇒ String

The ID of the user pool.

Returns:

  • (String) 


269
270
271
 
# File 'cognito/cfn_user_pool.rb', line 269

def attr_user_pool_id()
  jsii_get_property("attrUserPoolId")
end

#auto_verified_attributes ⇒ Array<String>?

The attributes that you want your user pool to automatically verify.

Returns:

  • (Array<String>, nil) 


340
341
342
 
# File 'cognito/cfn_user_pool.rb', line 340

def auto_verified_attributes()
  jsii_get_property("autoVerifiedAttributes")
end

#auto_verified_attributes=(value) ⇒ Object 



344
345
346
347
 
# File 'cognito/cfn_user_pool.rb', line 344

def auto_verified_attributes=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "autoVerifiedAttributes") unless value.nil?
  jsii_set_property("autoVerifiedAttributes", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



194
195
196
 
# File 'cognito/cfn_user_pool.rb', line 194

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


199
200
201
 
# File 'cognito/cfn_user_pool.rb', line 199

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


844
845
846
847
 
# File 'cognito/cfn_user_pool.rb', line 844

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


204
205
206
 
# File 'cognito/cfn_user_pool.rb', line 204

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


211
212
213
 
# File 'cognito/cfn_user_pool.rb', line 211

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


156
157
158
 
# File 'cognito/cfn_user_pool.rb', line 156

def creation_stack()
  jsii_get_property("creationStack")
end

#deletion_protection ⇒ String?

When active, DeletionProtection prevents accidental deletion of your user pool.

Returns:

  • (String, nil) 


352
353
354
 
# File 'cognito/cfn_user_pool.rb', line 352

def deletion_protection()
  jsii_get_property("deletionProtection")
end

#deletion_protection=(value) ⇒ Object 



356
357
358
359
 
# File 'cognito/cfn_user_pool.rb', line 356

def deletion_protection=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "deletionProtection") unless value.nil?
  jsii_set_property("deletionProtection", value)
end

#device_configuration ⇒ AWSCDK::IResolvable, ...

The device-remembering configuration for a user pool.

Returns:



364
365
366
 
# File 'cognito/cfn_user_pool.rb', line 364

def device_configuration()
  jsii_get_property("deviceConfiguration")
end

#device_configuration=(value) ⇒ Object 



368
369
370
371
372
 
# File 'cognito/cfn_user_pool.rb', line 368

def device_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Cognito::CfnUserPool::DeviceConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2duaXRvLkNmblVzZXJQb29sLkRldmljZUNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "deviceConfiguration") unless value.nil?
  jsii_set_property("deviceConfiguration", value)
end

#email_authentication_message ⇒ String?

Returns:

  • (String, nil) 


375
376
377
 
# File 'cognito/cfn_user_pool.rb', line 375

def email_authentication_message()
  jsii_get_property("emailAuthenticationMessage")
end

#email_authentication_message=(value) ⇒ Object 



379
380
381
382
 
# File 'cognito/cfn_user_pool.rb', line 379

def email_authentication_message=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "emailAuthenticationMessage") unless value.nil?
  jsii_set_property("emailAuthenticationMessage", value)
end

#email_authentication_subject ⇒ String?

Returns:

  • (String, nil) 


385
386
387
 
# File 'cognito/cfn_user_pool.rb', line 385

def email_authentication_subject()
  jsii_get_property("emailAuthenticationSubject")
end

#email_authentication_subject=(value) ⇒ Object 



389
390
391
392
 
# File 'cognito/cfn_user_pool.rb', line 389

def email_authentication_subject=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "emailAuthenticationSubject") unless value.nil?
  jsii_set_property("emailAuthenticationSubject", value)
end

#email_configuration ⇒ AWSCDK::IResolvable, ...

The email configuration of your user pool.

Returns:



397
398
399
 
# File 'cognito/cfn_user_pool.rb', line 397

def email_configuration()
  jsii_get_property("emailConfiguration")
end

#email_configuration=(value) ⇒ Object 



401
402
403
404
405
 
# File 'cognito/cfn_user_pool.rb', line 401

def email_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Cognito::CfnUserPool::EmailConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2duaXRvLkNmblVzZXJQb29sLkVtYWlsQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "emailConfiguration") unless value.nil?
  jsii_set_property("emailConfiguration", value)
end

#email_verification_message ⇒ String?

This parameter is no longer used.

Returns:

  • (String, nil) 


410
411
412
 
# File 'cognito/cfn_user_pool.rb', line 410

def email_verification_message()
  jsii_get_property("emailVerificationMessage")
end

#email_verification_message=(value) ⇒ Object 



414
415
416
417
 
# File 'cognito/cfn_user_pool.rb', line 414

def email_verification_message=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "emailVerificationMessage") unless value.nil?
  jsii_set_property("emailVerificationMessage", value)
end

#email_verification_subject ⇒ String?

This parameter is no longer used.

Returns:

  • (String, nil) 


422
423
424
 
# File 'cognito/cfn_user_pool.rb', line 422

def email_verification_subject()
  jsii_get_property("emailVerificationSubject")
end

#email_verification_subject=(value) ⇒ Object 



426
427
428
429
 
# File 'cognito/cfn_user_pool.rb', line 426

def email_verification_subject=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "emailVerificationSubject") unless value.nil?
  jsii_set_property("emailVerificationSubject", value)
end

#enabled_mfas ⇒ Array<String>?

Set enabled MFA options on a specified user pool.

Returns:

  • (Array<String>, nil) 


434
435
436
 
# File 'cognito/cfn_user_pool.rb', line 434

def enabled_mfas()
  jsii_get_property("enabledMfas")
end

#enabled_mfas=(value) ⇒ Object 



438
439
440
441
 
# File 'cognito/cfn_user_pool.rb', line 438

def enabled_mfas=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "enabledMfas") unless value.nil?
  jsii_set_property("enabledMfas", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



216
217
218
 
# File 'cognito/cfn_user_pool.rb', line 216

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



857
858
859
860
861
 
# File 'cognito/cfn_user_pool.rb', line 857

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



868
869
870
871
 
# File 'cognito/cfn_user_pool.rb', line 868

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



938
939
940
941
 
# File 'cognito/cfn_user_pool.rb', line 938

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#lambda_config ⇒ AWSCDK::IResolvable, ...

A collection of user pool Lambda triggers.

Returns:



446
447
448
 
# File 'cognito/cfn_user_pool.rb', line 446

def lambda_config()
  jsii_get_property("lambdaConfig")
end

#lambda_config=(value) ⇒ Object 



450
451
452
453
454
 
# File 'cognito/cfn_user_pool.rb', line 450

def lambda_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Cognito::CfnUserPool::LambdaConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2duaXRvLkNmblVzZXJQb29sLkxhbWJkYUNvbmZpZ1Byb3BlcnR5In1dfX0=")), "lambdaConfig") unless value.nil?
  jsii_set_property("lambdaConfig", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


168
169
170
 
# File 'cognito/cfn_user_pool.rb', line 168

def logical_id()
  jsii_get_property("logicalId")
end

#mfa_configuration ⇒ String?

Displays the state of multi-factor authentication (MFA) as on, off, or optional.

Returns:

  • (String, nil) 


459
460
461
 
# File 'cognito/cfn_user_pool.rb', line 459

def mfa_configuration()
  jsii_get_property("mfaConfiguration")
end

#mfa_configuration=(value) ⇒ Object 



463
464
465
466
 
# File 'cognito/cfn_user_pool.rb', line 463

def mfa_configuration=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "mfaConfiguration") unless value.nil?
  jsii_set_property("mfaConfiguration", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


151
152
153
 
# File 'cognito/cfn_user_pool.rb', line 151

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



879
880
881
 
# File 'cognito/cfn_user_pool.rb', line 879

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



886
887
888
 
# File 'cognito/cfn_user_pool.rb', line 886

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



679
680
681
682
 
# File 'cognito/cfn_user_pool.rb', line 679

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#policies ⇒ AWSCDK::IResolvable, ...

A list of user pool policies.

Returns:



471
472
473
 
# File 'cognito/cfn_user_pool.rb', line 471

def policies()
  jsii_get_property("policies")
end

#policies=(value) ⇒ Object 



475
476
477
478
479
 
# File 'cognito/cfn_user_pool.rb', line 475

def policies=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Cognito::CfnUserPool::PoliciesProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2duaXRvLkNmblVzZXJQb29sLlBvbGljaWVzUHJvcGVydHkifV19fQ==")), "policies") unless value.nil?
  jsii_set_property("policies", value)
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


187
188
189
 
# File 'cognito/cfn_user_pool.rb', line 187

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



897
898
899
900
 
# File 'cognito/cfn_user_pool.rb', line 897

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


904
905
906
907
 
# File 'cognito/cfn_user_pool.rb', line 904

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



914
915
916
917
918
 
# File 'cognito/cfn_user_pool.rb', line 914

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#schema ⇒ AWSCDK::IResolvable, ...

An array of attributes for the new user pool.

Returns:



484
485
486
 
# File 'cognito/cfn_user_pool.rb', line 484

def schema()
  jsii_get_property("schema")
end

#schema=(value) ⇒ Object 



488
489
490
491
 
# File 'cognito/cfn_user_pool.rb', line 488

def schema=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0by5DZm5Vc2VyUG9vbC5TY2hlbWFBdHRyaWJ1dGVQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "schema") unless value.nil?
  jsii_set_property("schema", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



923
924
925
 
# File 'cognito/cfn_user_pool.rb', line 923

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#sms_authentication_message ⇒ String?

The contents of the SMS authentication message.

Returns:

  • (String, nil) 


496
497
498
 
# File 'cognito/cfn_user_pool.rb', line 496

def sms_authentication_message()
  jsii_get_property("smsAuthenticationMessage")
end

#sms_authentication_message=(value) ⇒ Object 



500
501
502
503
 
# File 'cognito/cfn_user_pool.rb', line 500

def sms_authentication_message=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "smsAuthenticationMessage") unless value.nil?
  jsii_set_property("smsAuthenticationMessage", value)
end

#sms_configuration ⇒ AWSCDK::IResolvable, ...

The settings for your Amazon Cognito user pool to send SMS messages with Amazon Simple Notification Service.

Returns:



508
509
510
 
# File 'cognito/cfn_user_pool.rb', line 508

def sms_configuration()
  jsii_get_property("smsConfiguration")
end

#sms_configuration=(value) ⇒ Object 



512
513
514
515
516
 
# File 'cognito/cfn_user_pool.rb', line 512

def sms_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Cognito::CfnUserPool::SmsConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2duaXRvLkNmblVzZXJQb29sLlNtc0NvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "smsConfiguration") unless value.nil?
  jsii_set_property("smsConfiguration", value)
end

#sms_verification_message ⇒ String?

This parameter is no longer used.

Returns:

  • (String, nil) 


521
522
523
 
# File 'cognito/cfn_user_pool.rb', line 521

def sms_verification_message()
  jsii_get_property("smsVerificationMessage")
end

#sms_verification_message=(value) ⇒ Object 



525
526
527
528
 
# File 'cognito/cfn_user_pool.rb', line 525

def sms_verification_message=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "smsVerificationMessage") unless value.nil?
  jsii_set_property("smsVerificationMessage", value)
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



177
178
179
 
# File 'cognito/cfn_user_pool.rb', line 177

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



276
277
278
 
# File 'cognito/cfn_user_pool.rb', line 276

def tags()
  jsii_get_property("tags")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



655
656
657
 
# File 'cognito/cfn_user_pool.rb', line 655

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


224
225
226
 
# File 'cognito/cfn_user_pool.rb', line 224

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


234
235
236
 
# File 'cognito/cfn_user_pool.rb', line 234

def updated_properties()
  jsii_get_property("updatedProperties")
end

#user_attribute_update_settings ⇒ AWSCDK::IResolvable, ...

The settings for updates to user attributes.

Returns:



533
534
535
 
# File 'cognito/cfn_user_pool.rb', line 533

def user_attribute_update_settings()
  jsii_get_property("userAttributeUpdateSettings")
end

#user_attribute_update_settings=(value) ⇒ Object 



537
538
539
540
541
 
# File 'cognito/cfn_user_pool.rb', line 537

def user_attribute_update_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Cognito::CfnUserPool::UserAttributeUpdateSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2duaXRvLkNmblVzZXJQb29sLlVzZXJBdHRyaWJ1dGVVcGRhdGVTZXR0aW5nc1Byb3BlcnR5In1dfX0=")), "userAttributeUpdateSettings") unless value.nil?
  jsii_set_property("userAttributeUpdateSettings", value)
end

#user_pool_add_ons ⇒ AWSCDK::IResolvable, ...

Contains settings for activation of threat protection, including the operating mode and additional authentication types.

Returns:



571
572
573
 
# File 'cognito/cfn_user_pool.rb', line 571

def user_pool_add_ons()
  jsii_get_property("userPoolAddOns")
end

#user_pool_add_ons=(value) ⇒ Object 



575
576
577
578
579
 
# File 'cognito/cfn_user_pool.rb', line 575

def user_pool_add_ons=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Cognito::CfnUserPool::UserPoolAddOnsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2duaXRvLkNmblVzZXJQb29sLlVzZXJQb29sQWRkT25zUHJvcGVydHkifV19fQ==")), "userPoolAddOns") unless value.nil?
  jsii_set_property("userPoolAddOns", value)
end

#user_pool_name ⇒ String?

A friendly name for your user pool.

Returns:

  • (String, nil) 


584
585
586
 
# File 'cognito/cfn_user_pool.rb', line 584

def user_pool_name()
  jsii_get_property("userPoolName")
end

#user_pool_name=(value) ⇒ Object 



588
589
590
591
 
# File 'cognito/cfn_user_pool.rb', line 588

def user_pool_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "userPoolName") unless value.nil?
  jsii_set_property("userPoolName", value)
end

#user_pool_ref ⇒ AWSCDK::Interfaces::AWSCognito::UserPoolReference

A reference to a UserPool resource.

Returns:



283
284
285
 
# File 'cognito/cfn_user_pool.rb', line 283

def user_pool_ref()
  jsii_get_property("userPoolRef")
end

#user_pool_tags_raw ⇒ Object

The tag keys and values to assign to the user pool.

Returns:

  • (Object) 


290
291
292
 
# File 'cognito/cfn_user_pool.rb', line 290

def user_pool_tags_raw()
  jsii_get_property("userPoolTagsRaw")
end

#user_pool_tags_raw=(value) ⇒ Object 



294
295
296
297
 
# File 'cognito/cfn_user_pool.rb', line 294

def user_pool_tags_raw=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "userPoolTagsRaw")
  jsii_set_property("userPoolTagsRaw", value)
end

#user_pool_tier ⇒ String?

The user pool feature plan , or tier. This parameter determines the eligibility of the user pool for features like managed login, access-token customization, and threat protection. Defaults to ESSENTIALS .

Returns:

  • (String, nil) 


596
597
598
 
# File 'cognito/cfn_user_pool.rb', line 596

def user_pool_tier()
  jsii_get_property("userPoolTier")
end

#user_pool_tier=(value) ⇒ Object 



600
601
602
603
 
# File 'cognito/cfn_user_pool.rb', line 600

def user_pool_tier=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "userPoolTier") unless value.nil?
  jsii_set_property("userPoolTier", value)
end

#username_attributes ⇒ Array<String>?

Specifies whether a user can use an email address or phone number as a username when they sign up.

Returns:

  • (Array<String>, nil) 


546
547
548
 
# File 'cognito/cfn_user_pool.rb', line 546

def username_attributes()
  jsii_get_property("usernameAttributes")
end

#username_attributes=(value) ⇒ Object 



550
551
552
553
 
# File 'cognito/cfn_user_pool.rb', line 550

def username_attributes=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "usernameAttributes") unless value.nil?
  jsii_set_property("usernameAttributes", value)
end

#username_configuration ⇒ AWSCDK::IResolvable, ...

Sets the case sensitivity option for sign-in usernames.

Returns:



558
559
560
 
# File 'cognito/cfn_user_pool.rb', line 558

def username_configuration()
  jsii_get_property("usernameConfiguration")
end

#username_configuration=(value) ⇒ Object 



562
563
564
565
566
 
# File 'cognito/cfn_user_pool.rb', line 562

def username_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Cognito::CfnUserPool::UsernameConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2duaXRvLkNmblVzZXJQb29sLlVzZXJuYW1lQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "usernameConfiguration") unless value.nil?
  jsii_set_property("usernameConfiguration", value)
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


929
930
931
932
 
# File 'cognito/cfn_user_pool.rb', line 929

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#verification_message_template ⇒ AWSCDK::IResolvable, ...

The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.

Returns:



608
609
610
 
# File 'cognito/cfn_user_pool.rb', line 608

def verification_message_template()
  jsii_get_property("verificationMessageTemplate")
end

#verification_message_template=(value) ⇒ Object 



612
613
614
615
616
 
# File 'cognito/cfn_user_pool.rb', line 612

def verification_message_template=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Cognito::CfnUserPool::VerificationMessageTemplateProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2duaXRvLkNmblVzZXJQb29sLlZlcmlmaWNhdGlvbk1lc3NhZ2VUZW1wbGF0ZVByb3BlcnR5In1dfX0=")), "verificationMessageTemplate") unless value.nil?
  jsii_set_property("verificationMessageTemplate", value)
end

#web_authn_factor_configuration ⇒ String?

Returns:

  • (String, nil) 


619
620
621
 
# File 'cognito/cfn_user_pool.rb', line 619

def web_authn_factor_configuration()
  jsii_get_property("webAuthnFactorConfiguration")
end

#web_authn_factor_configuration=(value) ⇒ Object 



623
624
625
626
 
# File 'cognito/cfn_user_pool.rb', line 623

def web_authn_factor_configuration=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "webAuthnFactorConfiguration") unless value.nil?
  jsii_set_property("webAuthnFactorConfiguration", value)
end

#web_authn_relying_party_id ⇒ String?

Sets or displays the authentication domain, typically your user pool domain, that passkey providers must use as a relying party (RP) in their configuration.

Returns:

  • (String, nil) 


631
632
633
 
# File 'cognito/cfn_user_pool.rb', line 631

def web_authn_relying_party_id()
  jsii_get_property("webAuthnRelyingPartyId")
end

#web_authn_relying_party_id=(value) ⇒ Object 



635
636
637
638
 
# File 'cognito/cfn_user_pool.rb', line 635

def web_authn_relying_party_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "webAuthnRelyingPartyId") unless value.nil?
  jsii_set_property("webAuthnRelyingPartyId", value)
end

#web_authn_user_verification ⇒ String?

When required , users can only register and sign in users with passkeys that are capable of user verification . When preferred , your user pool doesn't require the use of authenticators with user verification but encourages it.

Returns:

  • (String, nil) 


643
644
645
 
# File 'cognito/cfn_user_pool.rb', line 643

def web_authn_user_verification()
  jsii_get_property("webAuthnUserVerification")
end

#web_authn_user_verification=(value) ⇒ Object 



647
648
649
650
 
# File 'cognito/cfn_user_pool.rb', line 647

def web_authn_user_verification=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "webAuthnUserVerification") unless value.nil?
  jsii_set_property("webAuthnUserVerification", value)
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


668
669
670
671
672
673
 
# File 'cognito/cfn_user_pool.rb', line 668

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end