Package com.pulumi.aws.cognito

Class UserArgs.Builder

  • Enclosing class:
    UserArgs
    public static final class UserArgs.Builder
extends java.lang.Object

    • Constructor Detail

      • Builder

        public Builder()

      • Builder

        public Builder​(UserArgs defaults)

    • Method Detail

      • attributes

        public UserArgs.Builder attributes​(@Nullable
                                   com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> attributes)
        Parameters:
        attributes - A map that contains user attributes and attribute values to be set for the user.
        Returns:
        builder

      • attributes

        public UserArgs.Builder attributes​(java.util.Map<java.lang.String,​java.lang.String> attributes)
        Parameters:
        attributes - A map that contains user attributes and attribute values to be set for the user.
        Returns:
        builder

      • clientMetadata

        public UserArgs.Builder clientMetadata​(@Nullable
                                       com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> clientMetadata)
        Parameters:
        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 `client_metadata` 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](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html).
        Returns:
        builder

      • clientMetadata

        public UserArgs.Builder clientMetadata​(java.util.Map<java.lang.String,​java.lang.String> clientMetadata)
        Parameters:
        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 `client_metadata` 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](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html).
        Returns:
        builder

      • desiredDeliveryMediums

        public UserArgs.Builder desiredDeliveryMediums​(@Nullable
                                               com.pulumi.core.Output<java.util.List<java.lang.String>> desiredDeliveryMediums)
        Parameters:
        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 `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"]`.
        Returns:
        builder

      • desiredDeliveryMediums

        public UserArgs.Builder desiredDeliveryMediums​(java.util.List<java.lang.String> desiredDeliveryMediums)
        Parameters:
        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 `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"]`.
        Returns:
        builder

      • desiredDeliveryMediums

        public UserArgs.Builder desiredDeliveryMediums​(java.lang.String... desiredDeliveryMediums)
        Parameters:
        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 `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"]`.
        Returns:
        builder

      • enabled

        public UserArgs.Builder enabled​(@Nullable
                                com.pulumi.core.Output<java.lang.Boolean> enabled)
        Parameters:
        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 `message_action` argument. Defaults to `true`.
        Returns:
        builder

      • enabled

        public UserArgs.Builder enabled​(java.lang.Boolean enabled)
        Parameters:
        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 `message_action` argument. Defaults to `true`.
        Returns:
        builder

      • forceAliasCreation

        public UserArgs.Builder forceAliasCreation​(@Nullable
                                           com.pulumi.core.Output<java.lang.Boolean> forceAliasCreation)
        Parameters:
        forceAliasCreation - If this parameter is set to True and the `phone_number` 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 `force_alias_creation` value. Defaults to `false`.
        Returns:
        builder

      • forceAliasCreation

        public UserArgs.Builder forceAliasCreation​(java.lang.Boolean forceAliasCreation)
        Parameters:
        forceAliasCreation - If this parameter is set to True and the `phone_number` 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 `force_alias_creation` value. Defaults to `false`.
        Returns:
        builder

      • messageAction

        public UserArgs.Builder messageAction​(@Nullable
                                      com.pulumi.core.Output<java.lang.String> messageAction)
        Parameters:
        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 `message_action` value.
        Returns:
        builder

      • messageAction

        public UserArgs.Builder messageAction​(java.lang.String messageAction)
        Parameters:
        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 `message_action` value.
        Returns:
        builder

      • password

        public UserArgs.Builder password​(@Nullable
                                 com.pulumi.core.Output<java.lang.String> password)
        Parameters:
        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 `temporary_password` value. You can suppress sending the welcome message with the `message_action` argument. Amazon Cognito does not store the `password` value. Conflicts with `temporary_password`.
        Returns:
        builder

      • password

        public UserArgs.Builder password​(java.lang.String password)
        Parameters:
        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 `temporary_password` value. You can suppress sending the welcome message with the `message_action` argument. Amazon Cognito does not store the `password` value. Conflicts with `temporary_password`.
        Returns:
        builder

      • temporaryPassword

        public UserArgs.Builder temporaryPassword​(@Nullable
                                          com.pulumi.core.Output<java.lang.String> temporaryPassword)
        Parameters:
        temporaryPassword - The user's temporary password. Conflicts with `password`.
        Returns:
        builder

      • temporaryPassword

        public UserArgs.Builder temporaryPassword​(java.lang.String temporaryPassword)
        Parameters:
        temporaryPassword - The user's temporary password. Conflicts with `password`.
        Returns:
        builder

      • userPoolId

        public UserArgs.Builder userPoolId​(com.pulumi.core.Output<java.lang.String> userPoolId)
        Parameters:
        userPoolId - The user pool ID for the user pool where the user will be created.
        Returns:
        builder

      • userPoolId

        public UserArgs.Builder userPoolId​(java.lang.String userPoolId)
        Parameters:
        userPoolId - The user pool ID for the user pool where the user will be created.
        Returns:
        builder

      • username

        public UserArgs.Builder username​(com.pulumi.core.Output<java.lang.String> username)
        Parameters:
        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. The following arguments are optional:
        Returns:
        builder

      • username

        public UserArgs.Builder username​(java.lang.String username)
        Parameters:
        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. The following arguments are optional:
        Returns:
        builder

      • validationData

        public UserArgs.Builder validationData​(@Nullable
                                       com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> validationData)
        Parameters:
        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 `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). > **NOTE:** Clearing `password` or `temporary_password` does not reset user's password in Cognito.
        Returns:
        builder

      • validationData

        public UserArgs.Builder validationData​(java.util.Map<java.lang.String,​java.lang.String> validationData)
        Parameters:
        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 `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). > **NOTE:** Clearing `password` or `temporary_password` does not reset user's password in Cognito.
        Returns:
        builder