Package com.pulumi.aws.cognito

Class UserArgs

  • public final class UserArgs
extends com.pulumi.resources.ResourceArgs

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  UserArgs.Builder  

      • Nested classes/interfaces inherited from class com.pulumi.resources.InputArgs

        com.pulumi.resources.InputArgs.InputArgsInternal

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static UserArgs Empty  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> attributes()  
      static UserArgs.Builder builder()  
      static UserArgs.Builder builder​(UserArgs defaults)  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> clientMetadata()  
      java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> desiredDeliveryMediums()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> enabled()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> forceAliasCreation()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> messageAction()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> password()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> temporaryPassword()  
      com.pulumi.core.Output<java.lang.String> username()  
      com.pulumi.core.Output<java.lang.String> userPoolId()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> validationData()  

      • Methods inherited from class com.pulumi.resources.ResourceArgs

        validateMember

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • Empty

        public static final UserArgs Empty

    • Method Detail

      • attributes

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

      • clientMetadata

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

      • desiredDeliveryMediums

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> desiredDeliveryMediums()
        Returns:
        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

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> enabled()
        Returns:
        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

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> forceAliasCreation()
        Returns:
        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

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> messageAction()
        Returns:
        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

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> password()
        Returns:
        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

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • temporaryPassword

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> temporaryPassword()
        Returns:
        The user's temporary password. Conflicts with `password`.

      • userPoolId

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

      • username

        public com.pulumi.core.Output<java.lang.String> username()
        Returns:
        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:

      • validationData

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> validationData()
        Returns:
        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](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html). > **NOTE:** Clearing `password` or `temporaryPassword` does not reset user's password in Cognito.