Interface SignUpRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CognitoIdentityProviderRequest.Builder, CopyableBuilder<SignUpRequest.Builder,SignUpRequest>, SdkBuilder<SignUpRequest.Builder,SignUpRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
SignUpRequest
@Mutable @NotThreadSafe public static interface SignUpRequest.Builder extends CognitoIdentityProviderRequest.Builder, SdkPojo, CopyableBuilder<SignUpRequest.Builder,SignUpRequest>

  • Method Details

    • clientId

      SignUpRequest.Builder clientId(String clientId)

      The ID of the app client where the user wants to sign up.

      Parameters:
      clientId - The ID of the app client where the user wants to sign up.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secretHash

      SignUpRequest.Builder secretHash(String secretHash)

      A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message. For more information about SecretHash, see Computing secret hash values.

      Parameters:
      secretHash - A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message. For more information about SecretHash, see Computing secret hash values.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • username

      SignUpRequest.Builder username(String username)

      The username of the user that you want to sign up. The value of this parameter is typically a username, but can be any alias attribute in your user pool.

      Parameters:
      username - The username of the user that you want to sign up. The value of this parameter is typically a username, but can be any alias attribute in your user pool.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • password

      SignUpRequest.Builder password(String password)

      The user's proposed password. The password must comply with the password requirements of your user pool.

      Users can sign up without a password when your user pool supports passwordless sign-in with email or SMS OTPs. To create a user with no password, omit this parameter or submit a blank value. You can only create a passwordless user when passwordless sign-in is available.

      Parameters:
      password - The user's proposed password. The password must comply with the password requirements of your user pool.

      Users can sign up without a password when your user pool supports passwordless sign-in with email or SMS OTPs. To create a user with no password, omit this parameter or submit a blank value. You can only create a passwordless user when passwordless sign-in is available.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userAttributes

      SignUpRequest.Builder userAttributes(Collection<AttributeType> userAttributes)

      An array of name-value pairs representing user attributes.

      For custom attributes, include a custom: prefix in the attribute name, for example custom:department.

      Parameters:
      userAttributes - An array of name-value pairs representing user attributes.

      For custom attributes, include a custom: prefix in the attribute name, for example custom:department.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userAttributes

      SignUpRequest.Builder userAttributes(AttributeType... userAttributes)

      An array of name-value pairs representing user attributes.

      For custom attributes, include a custom: prefix in the attribute name, for example custom:department.

      Parameters:
      userAttributes - An array of name-value pairs representing user attributes.

      For custom attributes, include a custom: prefix in the attribute name, for example custom:department.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userAttributes

      SignUpRequest.Builder userAttributes(Consumer<AttributeType.Builder>... userAttributes)

      An array of name-value pairs representing user attributes.

      For custom attributes, include a custom: prefix in the attribute name, for example custom:department.

      This is a convenience method that creates an instance of the AttributeType.Builder avoiding the need to create one manually via AttributeType.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to userAttributes(List<AttributeType>).

      Parameters:
      userAttributes - a consumer that will call methods on AttributeType.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • validationData

      SignUpRequest.Builder validationData(Collection<AttributeType> validationData)

      Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. This set of key-value pairs are for custom validation of information that you collect from your users but don't need to retain.

      Your Lambda function can analyze this additional data and act on it. Your function can automatically confirm and verify select users or perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs.

      For more information about the pre sign-up Lambda trigger, see Pre sign-up Lambda trigger.

      Parameters:
      validationData - Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. This set of key-value pairs are for custom validation of information that you collect from your users but don't need to retain.

      Your Lambda function can analyze this additional data and act on it. Your function can automatically confirm and verify select users or perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs.

      For more information about the pre sign-up Lambda trigger, see Pre sign-up Lambda trigger.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • validationData

      SignUpRequest.Builder validationData(AttributeType... validationData)

      Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. This set of key-value pairs are for custom validation of information that you collect from your users but don't need to retain.

      Your Lambda function can analyze this additional data and act on it. Your function can automatically confirm and verify select users or perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs.

      For more information about the pre sign-up Lambda trigger, see Pre sign-up Lambda trigger.

      Parameters:
      validationData - Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. This set of key-value pairs are for custom validation of information that you collect from your users but don't need to retain.

      Your Lambda function can analyze this additional data and act on it. Your function can automatically confirm and verify select users or perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs.

      For more information about the pre sign-up Lambda trigger, see Pre sign-up Lambda trigger.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • validationData

      SignUpRequest.Builder validationData(Consumer<AttributeType.Builder>... validationData)

      Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. This set of key-value pairs are for custom validation of information that you collect from your users but don't need to retain.

      Your Lambda function can analyze this additional data and act on it. Your function can automatically confirm and verify select users or perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs.

      For more information about the pre sign-up Lambda trigger, see Pre sign-up Lambda trigger.

      This is a convenience method that creates an instance of the AttributeType.Builder avoiding the need to create one manually via AttributeType.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to validationData(List<AttributeType>).

      Parameters:
      validationData - a consumer that will call methods on AttributeType.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • analyticsMetadata

      SignUpRequest.Builder analyticsMetadata(AnalyticsMetadataType analyticsMetadata)

      Information that supports analytics outcomes with Amazon Pinpoint, including the user's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier, email address, or phone number.

      Parameters:
      analyticsMetadata - Information that supports analytics outcomes with Amazon Pinpoint, including the user's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier, email address, or phone number.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • analyticsMetadata

      default SignUpRequest.Builder analyticsMetadata(Consumer<AnalyticsMetadataType.Builder> analyticsMetadata)

      Information that supports analytics outcomes with Amazon Pinpoint, including the user's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier, email address, or phone number.

      This is a convenience method that creates an instance of the AnalyticsMetadataType.Builder avoiding the need to create one manually via AnalyticsMetadataType.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to analyticsMetadata(AnalyticsMetadataType).

      Parameters:
      analyticsMetadata - a consumer that will call methods on AnalyticsMetadataType.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • userContextData

      SignUpRequest.Builder userContextData(UserContextDataType userContextData)

      Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat protection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

      For more information, see Collecting data for threat protection in applications.

      Parameters:
      userContextData - Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat protection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

      For more information, see Collecting data for threat protection in applications.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userContextData

      default SignUpRequest.Builder userContextData(Consumer<UserContextDataType.Builder> userContextData)

      Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat protection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

      For more information, see Collecting data for threat protection in applications.

      This is a convenience method that creates an instance of the UserContextDataType.Builder avoiding the need to create one manually via UserContextDataType.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to userContextData(UserContextDataType).

      Parameters:
      userContextData - a consumer that will call methods on UserContextDataType.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clientMetadata

      SignUpRequest.Builder clientMetadata(Map<String,String> clientMetadata)

      A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

      You create custom workflows by assigning Lambda functions to user pool triggers. When you use the SignUp API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and post confirmation. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your SignUp request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

      For more information, see Using Lambda triggers in the Amazon Cognito Developer Guide.

      When you use the ClientMetadata parameter, note that Amazon Cognito won't do the following:

      • 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 doesn't include triggers, the ClientMetadata parameter serves no purpose.

      • Validate the ClientMetadata value.

      • Encrypt the ClientMetadata value. Don't send sensitive information in this parameter.

      Parameters:
      clientMetadata - A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

      You create custom workflows by assigning Lambda functions to user pool triggers. When you use the SignUp API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and post confirmation. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your SignUp request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

      For more information, see Using Lambda triggers in the Amazon Cognito Developer Guide.

      When you use the ClientMetadata parameter, note that Amazon Cognito won't do the following:

      • 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 doesn't include triggers, the ClientMetadata parameter serves no purpose.

      • Validate the ClientMetadata value.

      • Encrypt the ClientMetadata value. Don't send sensitive information in this parameter.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      SignUpRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      SignUpRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.