Package software.amazon.awscdk.services.cognito

Class CfnUserPoolProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.cognito.CfnUserPoolProps.Jsii$Proxy

All Implemented Interfaces:

CfnUserPoolProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnUserPoolProps

@Stability(Stable)
@Internal
public static final class CfnUserPoolProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnUserPoolProps

An implementation for CfnUserPoolProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cognito.CfnUserPoolProps

CfnUserPoolProps.Builder, CfnUserPoolProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnUserPoolProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnUserPoolProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Object	getAccountRecoverySetting()	The available verified method a user can use to recover their password when they call ForgotPassword .
final Object	getAdminCreateUserConfig()	The settings for administrator creation of users in a user pool.
final List<String>	getAliasAttributes()	Attributes supported as an alias for this user pool.
final List<String>	getAutoVerifiedAttributes()	The attributes that you want your user pool to automatically verify.
final String	getDeletionProtection()	When active, DeletionProtection prevents accidental deletion of your user pool.
final Object	getDeviceConfiguration()	The device-remembering configuration for a user pool.
final String	getEmailAuthenticationMessage()
final String	getEmailAuthenticationSubject()
final Object	getEmailConfiguration()	The email configuration of your user pool.
final String	getEmailVerificationMessage()	This parameter is no longer used.
final String	getEmailVerificationSubject()	This parameter is no longer used.
final List<String>	getEnabledMfas()	Set enabled MFA options on a specified user pool.
final Object	getLambdaConfig()	A collection of user pool Lambda triggers.
final String	getMfaConfiguration()	Displays the state of multi-factor authentication (MFA) as on, off, or optional.
final Object	getPolicies()	A list of user pool policies.
final Object	getSchema()	An array of attributes for the new user pool.
final String	getSmsAuthenticationMessage()	The contents of the SMS authentication message.
final Object	getSmsConfiguration()	The settings for your Amazon Cognito user pool to send SMS messages with Amazon Simple Notification Service.
final String	getSmsVerificationMessage()	This parameter is no longer used.
final Object	getUserAttributeUpdateSettings()	The settings for updates to user attributes.
final List<String>	getUsernameAttributes()	Specifies whether a user can use an email address or phone number as a username when they sign up.
final Object	getUsernameConfiguration()	Sets the case sensitivity option for sign-in usernames.
final Object	getUserPoolAddOns()	Contains settings for activation of threat protection, including the operating mode and additional authentication types.
final String	getUserPoolName()	A friendly name for your user pool.
final Object	getUserPoolTags()	The tag keys and values to assign to the user pool.
final String	getUserPoolTier()	The user pool feature plan , or tier.
final Object	getVerificationMessageTemplate()	The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.
final String	getWebAuthnRelyingPartyId()	Sets or displays the authentication domain, typically your user pool domain, that passkey providers must use as a relying party (RP) in their configuration.
final String	getWebAuthnUserVerification()	When required , users can only register and sign in users with passkeys that are capable of user verification .
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnUserPoolProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnUserPoolProps.Builder.

Method Details

getAccountRecoverySetting

public final Object getAccountRecoverySetting()

Description copied from interface: CfnUserPoolProps

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

You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.

Returns union: either IResolvable or CfnUserPool.AccountRecoverySettingProperty

Specified by:

getAccountRecoverySetting in interface CfnUserPoolProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-accountrecoverysetting

getAdminCreateUserConfig

public final Object getAdminCreateUserConfig()

Description copied from interface: CfnUserPoolProps

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

Contains settings for allowing user sign-up, customizing invitation messages to new users, and the amount of time before temporary passwords expire.

Returns union: either IResolvable or CfnUserPool.AdminCreateUserConfigProperty

Specified by:

getAdminCreateUserConfig in interface CfnUserPoolProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-admincreateuserconfig

getAliasAttributes

public final List<String> getAliasAttributes()

Description copied from interface: CfnUserPoolProps

Attributes supported as an alias for this user pool.

For more information about alias attributes, see Customizing sign-in attributes .

Specified by:

getAliasAttributes in interface CfnUserPoolProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-aliasattributes

getAutoVerifiedAttributes

public final List<String> getAutoVerifiedAttributes()

Description copied from interface: CfnUserPoolProps

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

For more information, see Verifying contact information at sign-up .

Specified by:

getAutoVerifiedAttributes in interface CfnUserPoolProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-autoverifiedattributes

getDeletionProtection

public final String getDeletionProtection()

Description copied from interface: CfnUserPoolProps

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

Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.

When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.

Specified by:

getDeletionProtection in interface CfnUserPoolProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-deletionprotection

getDeviceConfiguration

public final Object getDeviceConfiguration()

Description copied from interface: CfnUserPoolProps

The device-remembering configuration for a user pool.

Device remembering or device tracking is a "Remember me on this device" option for user pools that perform authentication with the device key of a trusted device in the back end, instead of a user-provided MFA code. For more information about device authentication, see Working with user devices in your user pool . A null value indicates that you have deactivated device remembering in your user pool.

When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature. For more information, see Working with devices .

Returns union: either IResolvable or CfnUserPool.DeviceConfigurationProperty

Specified by:

getDeviceConfiguration in interface CfnUserPoolProps

See Also:

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

getEmailAuthenticationMessage

public final String getEmailAuthenticationMessage()

Specified by:

getEmailAuthenticationMessage in interface CfnUserPoolProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-emailauthenticationmessage

getEmailAuthenticationSubject

public final String getEmailAuthenticationSubject()

Specified by:

getEmailAuthenticationSubject in interface CfnUserPoolProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-emailauthenticationsubject

getEmailConfiguration

public final Object getEmailConfiguration()

Description copied from interface: CfnUserPoolProps

The email configuration of your user pool.

The email configuration type sets your preferred sending method, AWS Region, and sender for messages from your user pool.

Returns union: either IResolvable or CfnUserPool.EmailConfigurationProperty

Specified by:

getEmailConfiguration in interface CfnUserPoolProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-emailconfiguration

getEmailVerificationMessage

public final String getEmailVerificationMessage()

Description copied from interface: CfnUserPoolProps

This parameter is no longer used.

See VerificationMessageTemplateType .

Specified by:

getEmailVerificationMessage in interface CfnUserPoolProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-emailverificationmessage

getEmailVerificationSubject

public final String getEmailVerificationSubject()

Description copied from interface: CfnUserPoolProps

This parameter is no longer used.

See VerificationMessageTemplateType .

Specified by:

getEmailVerificationSubject in interface CfnUserPoolProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-emailverificationsubject

getEnabledMfas

public final List<String> getEnabledMfas()

Description copied from interface: CfnUserPoolProps

Set enabled MFA options on a specified user pool.

To disable all MFAs after it has been enabled, set MfaConfiguration to OFF and remove EnabledMfas. MFAs can only be all disabled if MfaConfiguration is OFF . After you enable SMS_MFA , you can only disable it by setting MfaConfiguration to OFF . Can be one of the following values:

• SMS_MFA - Enables MFA with SMS for the user pool. To select this option, you must also provide values for SmsConfiguration .
• SOFTWARE_TOKEN_MFA - Enables software token MFA for the user pool.
• EMAIL_OTP - Enables MFA with email for the user pool. To select this option, you must provide values for EmailConfiguration and within those, set EmailSendingAccount to DEVELOPER .

Allowed values: SMS_MFA | SOFTWARE_TOKEN_MFA | EMAIL_OTP

Specified by:

getEnabledMfas in interface CfnUserPoolProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-enabledmfas

getLambdaConfig

public final Object getLambdaConfig()

Description copied from interface: CfnUserPoolProps

A collection of user pool Lambda triggers.

Amazon Cognito invokes triggers at several possible stages of authentication operations. Triggers can modify the outcome of the operations that invoked them.

Returns union: either IResolvable or CfnUserPool.LambdaConfigProperty

Specified by:

getLambdaConfig in interface CfnUserPoolProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-lambdaconfig

getMfaConfiguration

public final String getMfaConfiguration()

Description copied from interface: CfnUserPoolProps

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

When ON , all users must set up MFA before they can sign in. When OPTIONAL , your application must make a client-side determination of whether a user wants to register an MFA device. For user pools with adaptive authentication with threat protection, choose OPTIONAL .

When MfaConfiguration is OPTIONAL , managed login doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in API responses and in managed login for users who have chosen and configured a preferred MFA factor.

Specified by:

getMfaConfiguration in interface CfnUserPoolProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-mfaconfiguration

getPolicies

public final Object getPolicies()

Description copied from interface: CfnUserPoolProps

A list of user pool policies.

Contains the policy that sets password-complexity requirements.

Returns union: either IResolvable or CfnUserPool.PoliciesProperty

Specified by:

getPolicies in interface CfnUserPoolProps

See Also:

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

getSchema

public final Object getSchema()

Description copied from interface: CfnUserPoolProps

An array of attributes for the new user pool.

You can add custom attributes and modify the properties of default attributes. The specifications in this parameter set the required attributes in your user pool. For more information, see Working with user attributes .

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnUserPool.SchemaAttributeProperty>

Specified by:

getSchema in interface CfnUserPoolProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-schema

getSmsAuthenticationMessage

public final String getSmsAuthenticationMessage()

Description copied from interface: CfnUserPoolProps

The contents of the SMS authentication message.

Specified by:

getSmsAuthenticationMessage in interface CfnUserPoolProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-smsauthenticationmessage

getSmsConfiguration

public final Object getSmsConfiguration()

Description copied from interface: CfnUserPoolProps

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

To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . For more information see SMS message settings .

Returns union: either IResolvable or CfnUserPool.SmsConfigurationProperty

Specified by:

getSmsConfiguration in interface CfnUserPoolProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-smsconfiguration

getSmsVerificationMessage

public final String getSmsVerificationMessage()

Description copied from interface: CfnUserPoolProps

This parameter is no longer used.

See VerificationMessageTemplateType .

Specified by:

getSmsVerificationMessage in interface CfnUserPoolProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-smsverificationmessage

getUserAttributeUpdateSettings

public final Object getUserAttributeUpdateSettings()

Description copied from interface: CfnUserPoolProps

The settings for updates to user attributes.

These settings include the property AttributesRequireVerificationBeforeUpdate , a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers .

Returns union: either IResolvable or CfnUserPool.UserAttributeUpdateSettingsProperty

Specified by:

getUserAttributeUpdateSettings in interface CfnUserPoolProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-userattributeupdatesettings

getUsernameAttributes

public final List<String> getUsernameAttributes()

Description copied from interface: CfnUserPoolProps

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

Specified by:

getUsernameAttributes in interface CfnUserPoolProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-usernameattributes

getUsernameConfiguration

public final Object getUsernameConfiguration()

Description copied from interface: CfnUserPoolProps

Sets the case sensitivity option for sign-in usernames.

When CaseSensitive is false (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, username , USERNAME , or UserName , or for email, email@example.com or EMaiL@eXamplE.Com . For most use cases, set case sensitivity to false as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user.

When CaseSensitive is true (case sensitive), Amazon Cognito interprets USERNAME and UserName as distinct users.

This configuration is immutable after you set it.

Returns union: either IResolvable or CfnUserPool.UsernameConfigurationProperty

Specified by:

getUsernameConfiguration in interface CfnUserPoolProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-usernameconfiguration

getUserPoolAddOns

public final Object getUserPoolAddOns()

Description copied from interface: CfnUserPoolProps

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

To log user security information but take no action, set to AUDIT . To configure automatic security responses to potentially unwanted 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 .

Returns union: either IResolvable or CfnUserPool.UserPoolAddOnsProperty

Specified by:

getUserPoolAddOns in interface CfnUserPoolProps

See Also:

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

getUserPoolName

public final String getUserPoolName()

Description copied from interface: CfnUserPoolProps

A friendly name for your user pool.

Specified by:

getUserPoolName in interface CfnUserPoolProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-userpoolname

getUserPoolTags

public final Object getUserPoolTags()

Description copied from interface: CfnUserPoolProps

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

A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

Specified by:

getUserPoolTags in interface CfnUserPoolProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-userpooltags

getUserPoolTier

public final String getUserPoolTier()

Description copied from interface: CfnUserPoolProps

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 .

Specified by:

getUserPoolTier in interface CfnUserPoolProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-userpooltier

getVerificationMessageTemplate

public final Object getVerificationMessageTemplate()

Description copied from interface: CfnUserPoolProps

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

Set the email message type that corresponds to your DefaultEmailOption selection. For CONFIRM_WITH_LINK , specify an EmailMessageByLink and leave EmailMessage blank. For CONFIRM_WITH_CODE , specify an EmailMessage and leave EmailMessageByLink blank. When you supply both parameters with either choice, Amazon Cognito returns an error.

Returns union: either IResolvable or CfnUserPool.VerificationMessageTemplateProperty

Specified by:

getVerificationMessageTemplate in interface CfnUserPoolProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-verificationmessagetemplate

getWebAuthnRelyingPartyId

public final String getWebAuthnRelyingPartyId()

Description copied from interface: CfnUserPoolProps

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

Under the following conditions, the passkey relying party ID must be the fully-qualified domain name of your custom domain:

• The user pool is configured for passkey authentication.
• The user pool has a custom domain, whether or not it also has a prefix domain.
• Your application performs authentication with managed login or the classic hosted UI.

Specified by:

getWebAuthnRelyingPartyId in interface CfnUserPoolProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-webauthnrelyingpartyid

getWebAuthnUserVerification

public final String getWebAuthnUserVerification()

Description copied from interface: CfnUserPoolProps

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.

Specified by:

getWebAuthnUserVerification in interface CfnUserPoolProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-webauthnuserverification

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object