UserArgs class

The set of arguments for User. The set of arguments for User.

Constructors

UserArgs({Input<Map<String, String>?>? attributes, Input<Map<String, String>?>? clientMetadata, Input<List<String>?>? desiredDeliveryMediums, Input<bool?>? enabled, Input<bool?>? forceAliasCreation, Input<String?>? messageAction, Input<String?>? password, Input<String?>? region, Input<String?>? temporaryPassword, required Input<String> userPoolId, required Input<String> username, Input<Map<String, String>?>? validationData})
Creates a new UserArgs. attributes A map that contains user attributes and attribute values to be set for the user. clientMetadata 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 clientMetadata value. 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. desiredDeliveryMediums A list of mediums to the welcome message will be sent through. Allowed values are EMAIL and SMS. If it's provided, make sure you have also specified email attribute for the EMAIL medium and phoneNumber for the SMS. More than one value can be specified. Amazon Cognito does not store the desiredDeliveryMediums value. Defaults to ["SMS"]. enabled Specifies whether the user should be enabled after creation. The welcome message will be sent regardless of the enabled value. The behavior can be changed with messageAction argument. Defaults to true. forceAliasCreation If this parameter is set to True and the phoneNumber or email address specified in the attributes parameter 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 the forceAliasCreation value. Defaults to false. messageAction Set to RESEND to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to SUPPRESS to suppress sending the message. Only one value can be specified. Amazon Cognito does not store the messageAction value. password 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 temporaryPassword value. You can suppress sending the welcome message with the messageAction argument. Amazon Cognito does not store the password value. Conflicts with temporaryPassword. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. temporaryPassword The user's temporary password. Conflicts with password. userPoolId The user pool ID for the user pool where the user will be created. username 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. validationData 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 validationData value. For more information, see Customizing User Pool Workflows with Lambda Triggers.
const
UserArgs.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 clientMetadata value. 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
desiredDeliveryMediums → Input<List<String>?>?
A list of mediums to the welcome message will be sent through. Allowed values are EMAIL and SMS. If it's provided, make sure you have also specified email attribute for the EMAIL medium and phoneNumber for the SMS. More than one value can be specified. Amazon Cognito does not store the desiredDeliveryMediums value. 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 enabled value. The behavior can be changed with messageAction argument. Defaults to true.
final
forceAliasCreation → Input<bool?>?
If this parameter is set to True and the phoneNumber or email address specified in the attributes parameter 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 the forceAliasCreation value. Defaults to false.
final
hashCode → int
The hash code for this object.
no setterinherited
messageAction → Input<String?>?
Set to RESEND to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to SUPPRESS to suppress sending the message. Only one value can be specified. Amazon Cognito does not store the messageAction value.
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 temporaryPassword value. You can suppress sending the welcome message with the messageAction argument. Amazon Cognito does not store the password value. Conflicts with temporaryPassword.
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
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 validationData value. 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