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

Interface ContextDataType.Builder

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

  • Method Details

    • ipAddress

      ContextDataType.Builder ipAddress(String ipAddress)

      The source IP address of your user's device.

      Parameters:
      ipAddress - The source IP address of your user's device.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serverName

      ContextDataType.Builder serverName(String serverName)

      The name of your application's service endpoint.

      Parameters:
      serverName - The name of your application's service endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serverPath

      ContextDataType.Builder serverPath(String serverPath)

      The path of your application's service endpoint.

      Parameters:
      serverPath - The path of your application's service endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • httpHeaders

      ContextDataType.Builder httpHeaders(Collection<HttpHeader> httpHeaders)

      The HTTP headers from your user's authentication request.

      Parameters:
      httpHeaders - The HTTP headers from your user's authentication request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • httpHeaders

      ContextDataType.Builder httpHeaders(HttpHeader... httpHeaders)

      The HTTP headers from your user's authentication request.

      Parameters:
      httpHeaders - The HTTP headers from your user's authentication request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • httpHeaders

      ContextDataType.Builder httpHeaders(Consumer<HttpHeader.Builder>... httpHeaders)

      The HTTP headers from your user's authentication request.

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

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

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

    • encodedData

      ContextDataType.Builder encodedData(String encodedData)

      Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library. For more information, see Adding user device and session data to API requests.

      Parameters:
      encodedData - Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library. For more information, see Adding user device and session data to API requests.
      Returns:
      Returns a reference to this object so that method calls can be chained together.