Interface ExportImageTask.Builder

  • Method Details

    • taskId

      The unique identifier for the export image task. Use this ID to track the task's progress and retrieve its details.

      Parameters:
      taskId - The unique identifier for the export image task. Use this ID to track the task's progress and retrieve its details.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • imageArn

      ExportImageTask.Builder imageArn(String imageArn)

      The ARN of the WorkSpaces Applications image being exported.

      Parameters:
      imageArn - The ARN of the WorkSpaces Applications image being exported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • amiName

      ExportImageTask.Builder amiName(String amiName)

      The name of the EC2 AMI that will be created by this export task.

      Parameters:
      amiName - The name of the EC2 AMI that will be created by this export task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • createdDate

      ExportImageTask.Builder createdDate(Instant createdDate)

      The date and time when the export image task was created.

      Parameters:
      createdDate - The date and time when the export image task was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • amiDescription

      ExportImageTask.Builder amiDescription(String amiDescription)

      The description that will be applied to the exported EC2 AMI.

      Parameters:
      amiDescription - The description that will be applied to the exported EC2 AMI.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • state

      The current state of the export image task, such as PENDING, RUNNING, COMPLETED, or FAILED.

      Parameters:
      state - The current state of the export image task, such as PENDING, RUNNING, COMPLETED, or FAILED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • state

      The current state of the export image task, such as PENDING, RUNNING, COMPLETED, or FAILED.

      Parameters:
      state - The current state of the export image task, such as PENDING, RUNNING, COMPLETED, or FAILED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • amiId

      The ID of the EC2 AMI that was created by this export task. This field is only populated when the task completes successfully.

      Parameters:
      amiId - The ID of the EC2 AMI that was created by this export task. This field is only populated when the task completes successfully.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • tagSpecifications

      ExportImageTask.Builder tagSpecifications(Map<String,String> tagSpecifications)

      The tags that will be applied to the exported EC2 AMI.

      Parameters:
      tagSpecifications - The tags that will be applied to the exported EC2 AMI.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • errorDetails

      ExportImageTask.Builder errorDetails(Collection<ErrorDetails> errorDetails)

      Details about any errors that occurred during the export process. This field is only populated when the task fails.

      Parameters:
      errorDetails - Details about any errors that occurred during the export process. This field is only populated when the task fails.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • errorDetails

      ExportImageTask.Builder errorDetails(ErrorDetails... errorDetails)

      Details about any errors that occurred during the export process. This field is only populated when the task fails.

      Parameters:
      errorDetails - Details about any errors that occurred during the export process. This field is only populated when the task fails.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • errorDetails

      ExportImageTask.Builder errorDetails(Consumer<ErrorDetails.Builder>... errorDetails)

      Details about any errors that occurred during the export process. This field is only populated when the task fails.

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

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

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