public static final class CfnUserPoolProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnUserPoolProps
CfnUserPoolProps
CfnUserPoolProps.Builder, CfnUserPoolProps.Jsii$Proxy
Modifier | Constructor and Description |
---|---|
protected |
Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
Constructor that initializes the object based on values retrieved from the JsiiObject.
|
Modifier and Type | Method and Description |
---|---|
com.fasterxml.jackson.databind.JsonNode |
$jsii$toJson() |
boolean |
equals(java.lang.Object o) |
java.lang.Object |
getAccountRecoverySetting()
Use this setting to define which verified available method a user can use to recover their password when they call `ForgotPassword` .
|
java.lang.Object |
getAdminCreateUserConfig()
The configuration for creating a new user profile.
|
java.util.List<java.lang.String> |
getAliasAttributes()
Attributes supported as an alias for this user pool.
|
java.util.List<java.lang.String> |
getAutoVerifiedAttributes()
The attributes to be auto-verified.
|
java.lang.Object |
getDeviceConfiguration()
The device configuration.
|
java.lang.Object |
getEmailConfiguration()
The email configuration of your user pool.
|
java.lang.String |
getEmailVerificationMessage()
A string representing the email verification message.
|
java.lang.String |
getEmailVerificationSubject()
A string representing the email verification subject.
|
java.util.List<java.lang.String> |
getEnabledMfas()
Enables MFA on a specified user pool.
|
java.lang.Object |
getLambdaConfig()
The Lambda trigger configuration information for the new user pool.
|
java.lang.String |
getMfaConfiguration()
The multi-factor (MFA) configuration.
|
java.lang.Object |
getPolicies()
The policy associated with a user pool.
|
java.lang.Object |
getSchema()
The schema attributes for the new user pool.
|
java.lang.String |
getSmsAuthenticationMessage()
A string representing the SMS authentication message.
|
java.lang.Object |
getSmsConfiguration()
The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service.
|
java.lang.String |
getSmsVerificationMessage()
A string representing the SMS verification message.
|
java.lang.Object |
getUserAttributeUpdateSettings()
The settings for updates to user attributes.
|
java.util.List<java.lang.String> |
getUsernameAttributes()
Determines whether email addresses or phone numbers can be specified as user names when a user signs up.
|
java.lang.Object |
getUsernameConfiguration()
You can choose to set case sensitivity on the username input for the selected sign-in option.
|
java.lang.Object |
getUserPoolAddOns()
Enables advanced security risk detection.
|
java.lang.String |
getUserPoolName()
A string used to name the user pool.
|
java.lang.Object |
getUserPoolTags()
The tag keys and values to assign to the user pool.
|
java.lang.Object |
getVerificationMessageTemplate()
The template for the verification message that the user sees when the app requests permission to access the user's information.
|
int |
hashCode() |
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
builder
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
objRef
- Reference to the JSII managed object.public final java.lang.Object getAccountRecoverySetting()
CfnUserPoolProps
It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.
getAccountRecoverySetting
in interface CfnUserPoolProps
public final java.lang.Object getAdminCreateUserConfig()
CfnUserPoolProps
getAdminCreateUserConfig
in interface CfnUserPoolProps
public final java.util.List<java.lang.String> getAliasAttributes()
CfnUserPoolProps
This user pool property cannot be updated.
getAliasAttributes
in interface CfnUserPoolProps
public final java.util.List<java.lang.String> getAutoVerifiedAttributes()
CfnUserPoolProps
Possible values: email , phone_number .
getAutoVerifiedAttributes
in interface CfnUserPoolProps
public final java.lang.Object getDeviceConfiguration()
CfnUserPoolProps
getDeviceConfiguration
in interface CfnUserPoolProps
public final java.lang.Object getEmailConfiguration()
CfnUserPoolProps
The email configuration type sets your preferred sending method, AWS Region, and sender for messages from your user pool.
getEmailConfiguration
in interface CfnUserPoolProps
public final java.lang.String getEmailVerificationMessage()
CfnUserPoolProps
EmailVerificationMessage is allowed only if EmailSendingAccount is DEVELOPER.
getEmailVerificationMessage
in interface CfnUserPoolProps
public final java.lang.String getEmailVerificationSubject()
CfnUserPoolProps
EmailVerificationSubject is allowed only if EmailSendingAccount is DEVELOPER.
getEmailVerificationSubject
in interface CfnUserPoolProps
public final java.util.List<java.lang.String> getEnabledMfas()
CfnUserPoolProps
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. Once SMS_MFA is enabled, SMS_MFA can only be disabled by setting MfaConfiguration to “OFF”. Can be one of the following values:
SMS_MFA
- Enables SMS MFA for the user pool. SMS_MFA can only be enabled if SMS configuration is provided.SOFTWARE_TOKEN_MFA
- Enables software token MFA for the user pool.
Allowed values: SMS_MFA
| SOFTWARE_TOKEN_MFA
getEnabledMfas
in interface CfnUserPoolProps
public final java.lang.Object getLambdaConfig()
CfnUserPoolProps
In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you must make an extra call to add permission for these event sources to invoke your Lambda function.
For more information on using the Lambda API to add permission, see AddPermission .
For adding permission using the AWS CLI , see add-permission .
getLambdaConfig
in interface CfnUserPoolProps
public final java.lang.String getMfaConfiguration()
CfnUserPoolProps
OFF
MFA won't be used for any users.ON
MFA is required for all users to sign in.OPTIONAL
MFA will be required only for individual users who have an MFA factor activated.getMfaConfiguration
in interface CfnUserPoolProps
public final java.lang.Object getPolicies()
CfnUserPoolProps
getPolicies
in interface CfnUserPoolProps
public final java.lang.Object getSchema()
CfnUserPoolProps
During a user pool update, you can add new schema attributes but you cannot modify or delete an existing schema attribute.
getSchema
in interface CfnUserPoolProps
public final java.lang.String getSmsAuthenticationMessage()
CfnUserPoolProps
getSmsAuthenticationMessage
in interface CfnUserPoolProps
public final java.lang.Object getSmsConfiguration()
CfnUserPoolProps
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 .
getSmsConfiguration
in interface CfnUserPoolProps
public final java.lang.String getSmsVerificationMessage()
CfnUserPoolProps
getSmsVerificationMessage
in interface CfnUserPoolProps
public final java.lang.Object getUserAttributeUpdateSettings()
CfnUserPoolProps
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 to email addresses and phone numbers .
getUserAttributeUpdateSettings
in interface CfnUserPoolProps
public final java.util.List<java.lang.String> getUsernameAttributes()
CfnUserPoolProps
Possible values: phone_number
or email
.
This user pool property cannot be updated.
getUsernameAttributes
in interface CfnUserPoolProps
public final java.lang.Object getUsernameConfiguration()
CfnUserPoolProps
For example, when this is set to False
, users will be able to sign in using either "username" or "Username". This configuration is immutable once it has been set.
getUsernameConfiguration
in interface CfnUserPoolProps
public final java.lang.Object getUserPoolAddOns()
CfnUserPoolProps
Set the key AdvancedSecurityMode
to the value "AUDIT".
getUserPoolAddOns
in interface CfnUserPoolProps
public final java.lang.String getUserPoolName()
CfnUserPoolProps
getUserPoolName
in interface CfnUserPoolProps
public final java.lang.Object getUserPoolTags()
CfnUserPoolProps
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.
getUserPoolTags
in interface CfnUserPoolProps
public final java.lang.Object getVerificationMessageTemplate()
CfnUserPoolProps
getVerificationMessageTemplate
in interface CfnUserPoolProps
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
public final boolean equals(java.lang.Object o)
public final int hashCode()