Interface ConfirmSignUpRequest.Builder

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

  • Method Details

    • clientId

      ConfirmSignUpRequest.Builder clientId(String clientId)

      The ID of the app client associated with the user pool.

      Parameters:
      clientId - The ID of the app client associated with the user pool.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secretHash

      ConfirmSignUpRequest.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

      ConfirmSignUpRequest.Builder username(String username)

      The name of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

      Parameters:
      username - The name of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • confirmationCode

      ConfirmSignUpRequest.Builder confirmationCode(String confirmationCode)

      The confirmation code that your user pool sent in response to the SignUp request.

      Parameters:
      confirmationCode - The confirmation code that your user pool sent in response to the SignUp request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • forceAliasCreation

      ConfirmSignUpRequest.Builder forceAliasCreation(Boolean forceAliasCreation)

      When true, forces user confirmation despite any existing aliases. Defaults to false . A value of true migrates the alias from an existing user to the new user if an existing user already has the phone number or email address as an alias.

      Say, for example, that an existing user has an email attribute of bob@example.com and email is an alias in your user pool. If the new user also has an email of bob@example.com and your ConfirmSignUp response sets ForceAliasCreation to true, the new user can sign in with a username of bob@example.com and the existing user can no longer do so.

      If false and an attribute belongs to an existing alias, this request returns an AliasExistsException error.

      For more information about sign-in aliases, see Customizing sign-in attributes.

      Parameters:
      forceAliasCreation - When true, forces user confirmation despite any existing aliases. Defaults to false. A value of true migrates the alias from an existing user to the new user if an existing user already has the phone number or email address as an alias.

      Say, for example, that an existing user has an email attribute of bob@example.com and email is an alias in your user pool. If the new user also has an email of bob@example.com and your ConfirmSignUp response sets ForceAliasCreation to true, the new user can sign in with a username of bob@example.com and the existing user can no longer do so.

      If false and an attribute belongs to an existing alias, this request returns an AliasExistsException error.

      For more information about sign-in aliases, see Customizing sign-in attributes.

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

    • analyticsMetadata

      ConfirmSignUpRequest.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 ConfirmSignUpRequest.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

      ConfirmSignUpRequest.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 ConfirmSignUpRequest.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

      ConfirmSignUpRequest.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 ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, 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 ConfirmSignUp 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 ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, 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 ConfirmSignUp 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.

    • session

      ConfirmSignUpRequest.Builder session(String session)

      The optional session ID from a SignUp API request. You can sign in a user directly from the sign-up process with the USER_AUTH authentication flow.

      Parameters:
      session - The optional session ID from a SignUp API request. You can sign in a user directly from the sign-up process with the USER_AUTH authentication flow.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      ConfirmSignUpRequest.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

      ConfirmSignUpRequest.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.