UserState class
Input properties used for looking up and filtering User resources.
Constructors
-
UserState({Input<
Map< ? attributes, Input<String, String> ?>Map< ? clientMetadata, Input<String, String> ?>String?> ? creationDate, Input<List< ? desiredDeliveryMediums, Input<String> ?>bool?> ? enabled, Input<bool?> ? forceAliasCreation, Input<String?> ? lastModifiedDate, Input<String?> ? messageAction, Input<List< ? mfaSettingLists, Input<String> ?>String?> ? password, Input<String?> ? preferredMfaSetting, Input<String?> ? region, Input<String?> ? status, Input<String?> ? sub, Input<String?> ? temporaryPassword, Input<String?> ? userPoolId, Input<String?> ? username, Input<Map< ? validationData})String, String> ?> -
Creates a new UserState.
attributesA map that contains user attributes and attribute values to be set for the user.clientMetadataA map of custom key-value pairs that you can provide as input for any custom workflows that user creation triggers. Amazon Cognito does not store theclientMetadatavalue. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose. For more information, see Customizing User Pool Workflows with Lambda Triggers.creationDateOptional.desiredDeliveryMediumsA list of mediums to the welcome message will be sent through. Allowed values areEMAILandSMS. If it's provided, make sure you have also specifiedemailattribute for theEMAILmedium andphoneNumberfor theSMS. More than one value can be specified. Amazon Cognito does not store thedesiredDeliveryMediumsvalue. Defaults to["SMS"].enabledSpecifies whether the user should be enabled after creation. The welcome message will be sent regardless of theenabledvalue. The behavior can be changed withmessageActionargument. Defaults totrue.forceAliasCreationIf this parameter is set to True and thephoneNumberoremailaddress specified in theattributesparameter already exists as an alias with a different user, Amazon Cognito will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias. Amazon Cognito does not store theforceAliasCreationvalue. Defaults tofalse.lastModifiedDateOptional.messageActionSet toRESENDto resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set toSUPPRESSto suppress sending the message. Only one value can be specified. Amazon Cognito does not store themessageActionvalue.mfaSettingListsOptional.passwordThe user's permanent password. This password must conform to the password policy specified by user pool the user belongs to. The welcome message always contains onlytemporaryPasswordvalue. You can suppress sending the welcome message with themessageActionargument. Amazon Cognito does not store thepasswordvalue. Conflicts withtemporaryPassword.preferredMfaSettingOptional.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.statuscurrent user status.subunique user id that is never reassignable to another user.temporaryPasswordThe user's temporary password. Conflicts withpassword.userPoolIdThe user pool ID for the user pool where the user will be created.usernameThe username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username cannot be changed.validationDataThe user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. Amazon Cognito does not store thevalidationDatavalue. For more information, see Customizing User Pool Workflows with Lambda Triggers.const -
UserState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
attributes
→ Input<
Map< ?String, String> ?> -
A map that contains user attributes and attribute values to be set for the user.
final
-
clientMetadata
→ Input<
Map< ?String, String> ?> -
A map of custom key-value pairs that you can provide as input for any custom workflows that user creation triggers. Amazon Cognito does not store the
clientMetadatavalue. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose. For more information, see Customizing User Pool Workflows with Lambda Triggers.final -
creationDate
→ Input<
String?> ? -
final
-
desiredDeliveryMediums
→ Input<
List< ?String> ?> -
A list of mediums to the welcome message will be sent through. Allowed values are
EMAILandSMS. If it's provided, make sure you have also specifiedemailattribute for theEMAILmedium andphoneNumberfor theSMS. More than one value can be specified. Amazon Cognito does not store thedesiredDeliveryMediumsvalue. Defaults to["SMS"].final -
enabled
→ Input<
bool?> ? -
Specifies whether the user should be enabled after creation. The welcome message will be sent regardless of the
enabledvalue. The behavior can be changed withmessageActionargument. Defaults totrue.final -
forceAliasCreation
→ Input<
bool?> ? -
If this parameter is set to True and the
phoneNumberoremailaddress specified in theattributesparameter already exists as an alias with a different user, Amazon Cognito will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias. Amazon Cognito does not store theforceAliasCreationvalue. Defaults tofalse.final - hashCode → int
-
The hash code for this object.
no setterinherited
-
lastModifiedDate
→ Input<
String?> ? -
final
-
messageAction
→ Input<
String?> ? -
Set to
RESENDto resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set toSUPPRESSto suppress sending the message. Only one value can be specified. Amazon Cognito does not store themessageActionvalue.final -
mfaSettingLists
→ Input<
List< ?String> ?> -
final
-
password
→ Input<
String?> ? -
The user's permanent password. This password must conform to the password policy specified by user pool the user belongs to. The welcome message always contains only
temporaryPasswordvalue. You can suppress sending the welcome message with themessageActionargument. Amazon Cognito does not store thepasswordvalue. Conflicts withtemporaryPassword.final -
preferredMfaSetting
→ Input<
String?> ? -
final
-
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
status
→ Input<
String?> ? -
current user status.
final
-
sub
→ Input<
String?> ? -
unique user id that is never reassignable to another user.
final
-
temporaryPassword
→ Input<
String?> ? -
The user's temporary password. Conflicts with
password.final -
username
→ Input<
String?> ? -
The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username cannot be changed.
final
-
userPoolId
→ Input<
String?> ? -
The user pool ID for the user pool where the user will be created.
final
-
validationData
→ Input<
Map< ?String, String> ?> -
The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. Amazon Cognito does not store the
validationDatavalue. For more information, see Customizing User Pool Workflows with Lambda Triggers.final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited