Interface GetClientTokenRequest.Builder

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

  • Method Details

    • clientId

      GetClientTokenRequest.Builder clientId(String clientId)

      The ID of the app client that requests the access token. The app client must have a client secret and the ALLOW_CLIENT_TOKEN_AUTH authentication flow.

      Parameters:
      clientId - The ID of the app client that requests the access token. The app client must have a client secret and the ALLOW_CLIENT_TOKEN_AUTH authentication flow.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secret

      GetClientTokenRequest.Builder secret(String secret)

      An active secret for the app client.

      Parameters:
      secret - An active secret for the app client.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scopes

      GetClientTokenRequest.Builder scopes(Collection<String> scopes)

      The custom scopes to authorize in the access token, in the format resource-server-identifier/scope-name. Each scope must belong to a resource server in your user pool. If you don't specify any scopes, Amazon Cognito authorizes the scopes that are configured for the app client.

      Parameters:
      scopes - The custom scopes to authorize in the access token, in the format resource-server-identifier/scope-name. Each scope must belong to a resource server in your user pool. If you don't specify any scopes, Amazon Cognito authorizes the scopes that are configured for the app client.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scopes

      GetClientTokenRequest.Builder scopes(String... scopes)

      The custom scopes to authorize in the access token, in the format resource-server-identifier/scope-name. Each scope must belong to a resource server in your user pool. If you don't specify any scopes, Amazon Cognito authorizes the scopes that are configured for the app client.

      Parameters:
      scopes - The custom scopes to authorize in the access token, in the format resource-server-identifier/scope-name. Each scope must belong to a resource server in your user pool. If you don't specify any scopes, Amazon Cognito authorizes the scopes that are configured for the app client.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientMetadata

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

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

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