nodes/generated

Interface AwsCognitoNodeParameters

Source
interface AwsCognitoNodeParameters {
    additionalFields?:
        | {
            arn?: string;
            description?: string;
            precedence?: number;
        }
        | {
            desiredDeliveryMediums?: ("SMS" | "EMAIL")[];
            forceAliasCreation?: boolean;
            messageAction?: "RESEND" | "SUPPRESS";
            temporaryPasswordOptions?: string;
            userAttributes: {
                attributes: {
                    attributeType?: "custom" | "standard";
                    customName?: string;
                    standardName?:
                        | "address"
                        | "birthdate"
                        | "email"
                        | "email_verified"
                        | "family_name"
                        | "gender"
                        | "given_name"
                        | "locale"
                        | "middle_name"
                        | "name"
                        | "nickname"
                        | "phone_number"
                        | "phone_number_verified"
                        | "preferred_username"
                        | "profilepicture"
                        | "updated_at"
                        | "sub"
                        | "website"
                        | "zoneinfo";
                    value?: string;
                }[];
            };
        };
    filters?: {
        filter: {
            attribute?: | "email"
            | "family_name"
            | "given_name"
            | "name"
            | "phone_number"
            | "preferred_username"
            | "sub"
            | "cognito:user_status"
            | "status"
            | "username";
            value?: string;
        };
    };
    group?: { mode: "list"
    | "groupName"; value: string };
    includeUsers?: boolean;
    limit?: number;
    newGroupName?: string;
    newUserName?: string;
    operation?:
        | "create"
        | "get"
        | "getAll"
        | "update"
        | "delete"
        | "addToGroup"
        | "removeFromGroup";
    resource?: "user"
    | "group"
    | "userPool";
    returnAll?: boolean;
    simple?: boolean;
    user?: { mode: "id" | "list"; value: string };
    userAttributes?: {
        attributes: {
            attributeType?: "custom" | "standard";
            customName?: string;
            standardName?:
                | "address"
                | "birthdate"
                | "email"
                | "family_name"
                | "gender"
                | "given_name"
                | "locale"
                | "middle_name"
                | "name"
                | "nickname"
                | "phone_number"
                | "preferred_username"
                | "profilepicture"
                | "updated_at"
                | "sub"
                | "website"
                | "zoneinfo";
            value?: string;
        }[];
    };
    userPool?: { mode: "id"
    | "list"; value: string };
}

Properties§

Source§

readonly additionalFields?:
    | {
        arn?: string;
        description?: string;
        precedence?: number;
    }
    | {
        desiredDeliveryMediums?: ("SMS" | "EMAIL")[];
        forceAliasCreation?: boolean;
        messageAction?: "RESEND" | "SUPPRESS";
        temporaryPasswordOptions?: string;
        userAttributes: {
            attributes: {
                attributeType?: "custom" | "standard";
                customName?: string;
                standardName?:
                    | "address"
                    | "birthdate"
                    | "email"
                    | "email_verified"
                    | "family_name"
                    | "gender"
                    | "given_name"
                    | "locale"
                    | "middle_name"
                    | "name"
                    | "nickname"
                    | "phone_number"
                    | "phone_number_verified"
                    | "preferred_username"
                    | "profilepicture"
                    | "updated_at"
                    | "sub"
                    | "website"
                    | "zoneinfo";
                value?: string;
            }[];
        };
    }

Default: {}

Source§

readonly filters?: {
    filter: {
        attribute?:
            | "email"
            | "family_name"
            | "given_name"
            | "name"
            | "phone_number"
            | "preferred_username"
            | "sub"
            | "cognito:user_status"
            | "status"
            | "username";
        value?: string;
    };
}

Default: {}

Source§

readonly group?: { mode: "list" | "groupName"; value: string }

Select the group you want to delete Default: {"mode":"list","value":""}

Source§

readonly includeUsers?: boolean

Whether to include a list of users in the group

Source§

readonly limit?: number

Max number of results to return Default: 50 Type options: {"minValue":1,"maxValue":60}

Source§

readonly newGroupName?: string

The name of the new group to create

Source§

readonly newUserName?: string

Depending on the user pool settings, this parameter requires the username, the email, or the phone number. No whitespace is allowed.

Source§

readonly operation?:
    | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete"
    | "addToGroup"
    | "removeFromGroup"

Default: "getAll"

Source§

readonly resource?: "user" | "group" | "userPool"

Default: "user"

Source§

readonly returnAll?: boolean

Whether to return all results or only up to a given limit

Source§

readonly simple?: boolean

Whether to return a simplified version of the response instead of the raw data Default: true

Source§

readonly user?: { mode: "id" | "list"; value: string }

Select the user you want to delete Default: {"mode":"list","value":""}

Source§

readonly userAttributes?: {
    attributes: {
        attributeType?: "custom" | "standard";
        customName?: string;
        standardName?:
            | "address"
            | "birthdate"
            | "email"
            | "family_name"
            | "gender"
            | "given_name"
            | "locale"
            | "middle_name"
            | "name"
            | "nickname"
            | "phone_number"
            | "preferred_username"
            | "profilepicture"
            | "updated_at"
            | "sub"
            | "website"
            | "zoneinfo";
        value?: string;
    }[];
}

Attributes to update for the user Default: {"attributes":[]} Type options: {"multipleValues":true}

Source§

readonly userPool?: { mode: "id" | "list"; value: string }

Select the user pool to use Default: {"mode":"list","value":""}