Interface GetTokensFromRefreshTokenRequest.Builder

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

  • Method Details

    • refreshToken

      GetTokensFromRefreshTokenRequest.Builder refreshToken(String refreshToken)

      A valid refresh token that can authorize the request for new tokens. When refresh token rotation is active in the requested app client, this token is invalidated after the request is complete and after an optional grace period.

      Parameters:
      refreshToken - A valid refresh token that can authorize the request for new tokens. When refresh token rotation is active in the requested app client, this token is invalidated after the request is complete and after an optional grace period.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientId

      GetTokensFromRefreshTokenRequest.Builder clientId(String clientId)

      The app client that issued the refresh token to the user who wants to request new tokens.

      Parameters:
      clientId - The app client that issued the refresh token to the user who wants to request new tokens.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientSecret

      GetTokensFromRefreshTokenRequest.Builder clientSecret(String clientSecret)

      The client secret of the requested app client, if the client has a secret.

      Parameters:
      clientSecret - The client secret of the requested app client, if the client has a secret.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deviceKey

      GetTokensFromRefreshTokenRequest.Builder deviceKey(String deviceKey)

      When you enable device remembering, Amazon Cognito issues a device key that you can use for device authentication that bypasses multi-factor authentication (MFA). To implement GetTokensFromRefreshToken in a user pool with device remembering, you must capture the device key from the initial authentication request. If your application doesn't provide the key of a registered device, Amazon Cognito issues a new one. You must provide the confirmed device key in this request if device remembering is enabled in your user pool.

      For more information about device remembering, see Working with devices.

      Parameters:
      deviceKey - When you enable device remembering, Amazon Cognito issues a device key that you can use for device authentication that bypasses multi-factor authentication (MFA). To implement GetTokensFromRefreshToken in a user pool with device remembering, you must capture the device key from the initial authentication request. If your application doesn't provide the key of a registered device, Amazon Cognito issues a new one. You must provide the confirmed device key in this request if device remembering is enabled in your user pool.

      For more information about device remembering, see Working with devices.

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

    • clientMetadata

      GetTokensFromRefreshTokenRequest.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 Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute that provides the data that you assigned to the ClientMetadata parameter in your request. In your function code, you can process the clientMetadata value to enhance your workflow for your specific needs.

      To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see Connecting API actions to 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 Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute that provides the data that you assigned to the ClientMetadata parameter in your request. In your function code, you can process the clientMetadata value to enhance your workflow for your specific needs.

      To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see Connecting API actions to 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

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

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