import * as core from "@terrascript/core"; export interface UserArgs extends core.ResourceArgs { /** * (Optional) A map that contains user attributes and attribute values to be set for the user. */ attributes?: core.Map | core.MapOut; /** * (Optional) A map of custom key-value pairs that you can provide as input for any custom workflows th * at user creation triggers. Amazon Cognito does not store the `client_metadata` value. This data is a * vailable only to Lambda triggers that are assigned to a user pool to support custom workflows. If yo * ur user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose * . For more information, see [Customizing User Pool Workflows with Lambda Triggers](https://docs.aws. * amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-trigger * s.html). */ clientMetadata?: core.Map | core.MapOut; /** * (Optional) 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` me * dium and `phone_number` for the `SMS`. More than one value can be specified. Amazon Cognito does not * store the `desired_delivery_mediums` value. Defaults to `["SMS"]`. */ desiredDeliveryMediums?: core.Array | core.ArrayOut; /** * (Optional) 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 `message_action` argument. * Defaults to `true`. */ enabled?: boolean | core.BooleanOut; /** * (Optional) If this parameter is set to True and the `phone_number` or `email` address specified in t * he `attributes` parameter already exists as an alias with a different user, Amazon Cognito will migr * ate 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 `force_alias_creation` value. Def * aults to `false`. */ forceAliasCreation?: boolean | core.BooleanOut; /** * (Optional) 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 `message_action` value. */ messageAction?: string | core.StringOut; /** * (Optional) The user's permanent password. This password must conform to the password policy specifie * d by user pool the user belongs to. The welcome message always contains only `temporary_password` va * lue. You can suppress sending the welcome message with the `message_action` argument. Amazon Cognito * does not store the `password` value. Conflicts with `temporary_password`. */ password?: string | core.StringOut; /** * (Optional) The user's temporary password. Conflicts with `password`. */ temporaryPassword?: string | core.StringOut; /** * (Required) The user pool ID for the user pool where the user will be created. */ userPoolId: string | core.StringOut; username: string | core.StringOut; /** * (Optional) The user's validation data. This is an array of name-value pairs that contain user attrib * utes and attribute values that you can use for custom validation, such as restricting the types of u * ser accounts that can be registered. Amazon Cognito does not store the `validation_data` value. For * more information, see [Customizing User Pool Workflows with Lambda Triggers](https://docs.aws.amazon * .com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html * ). */ validationData?: core.Map | core.MapOut; } export declare class User extends core.Resource { /** * (Optional) A map that contains user attributes and attribute values to be set for the user. */ attributes?: core.Map | core.MapOut; /** * (Optional) A map of custom key-value pairs that you can provide as input for any custom workflows th * at user creation triggers. Amazon Cognito does not store the `client_metadata` value. This data is a * vailable only to Lambda triggers that are assigned to a user pool to support custom workflows. If yo * ur user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose * . For more information, see [Customizing User Pool Workflows with Lambda Triggers](https://docs.aws. * amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-trigger * s.html). */ clientMetadata?: core.Map | core.MapOut; creationDate: string | core.StringOut; /** * (Optional) 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` me * dium and `phone_number` for the `SMS`. More than one value can be specified. Amazon Cognito does not * store the `desired_delivery_mediums` value. Defaults to `["SMS"]`. */ desiredDeliveryMediums?: core.Array | core.ArrayOut; /** * (Optional) 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 `message_action` argument. * Defaults to `true`. */ enabled?: boolean | core.BooleanOut; /** * (Optional) If this parameter is set to True and the `phone_number` or `email` address specified in t * he `attributes` parameter already exists as an alias with a different user, Amazon Cognito will migr * ate 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 `force_alias_creation` value. Def * aults to `false`. */ forceAliasCreation?: boolean | core.BooleanOut; id: string | core.StringOut; lastModifiedDate: string | core.StringOut; /** * (Optional) 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 `message_action` value. */ messageAction?: string | core.StringOut; mfaSettingList: core.Array | core.ArrayOut; /** * (Optional) The user's permanent password. This password must conform to the password policy specifie * d by user pool the user belongs to. The welcome message always contains only `temporary_password` va * lue. You can suppress sending the welcome message with the `message_action` argument. Amazon Cognito * does not store the `password` value. Conflicts with `temporary_password`. */ password?: string | core.StringOut; preferredMfaSetting: string | core.StringOut; /** * current user status. */ status: string | core.StringOut; /** * unique user id that is never reassignable to another user. */ sub: string | core.StringOut; /** * (Optional) The user's temporary password. Conflicts with `password`. */ temporaryPassword?: string | core.StringOut; /** * (Required) The user pool ID for the user pool where the user will be created. */ userPoolId: string | core.StringOut; username: string | core.StringOut; /** * (Optional) The user's validation data. This is an array of name-value pairs that contain user attrib * utes and attribute values that you can use for custom validation, such as restricting the types of u * ser accounts that can be registered. Amazon Cognito does not store the `validation_data` value. For * more information, see [Customizing User Pool Workflows with Lambda Triggers](https://docs.aws.amazon * .com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html * ). */ validationData?: core.Map | core.MapOut; constructor(name: string, args?: UserArgs); getNamespace(): string; } //# sourceMappingURL=user.d.ts.map