Package software.amazon.awssdk.services.cognitoidentityprovider.model

Interface ResendConfirmationCodeRequest.Builder

    • Method Detail

      • clientId

        ResendConfirmationCodeRequest.Builder clientId​(String clientId)

        The ID of the user pool app client where the user signed up.

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

      • secretHash

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

      • userContextData

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

      • username

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

      • analyticsMetadata

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

      • clientMetadata

        ResendConfirmationCodeRequest.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 ResendConfirmationCode API action, Amazon Cognito invokes the function that is assigned to the custom message 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 ResendConfirmationCode 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 ResendConfirmationCode API action, Amazon Cognito invokes the function that is assigned to the custom message 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 ResendConfirmationCode 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.