Interface ImportVmImageRequest.Builder

  • Method Details

    • name

      The name of the base image that is created by the import process.

      Parameters:
      name - The name of the base image that is created by the import process.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • semanticVersion

      ImportVmImageRequest.Builder semanticVersion(String semanticVersion)

      The semantic version to attach to the base image that was created during the import process. This version follows the semantic version syntax.

      The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

      Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.

      Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

      Parameters:
      semanticVersion - The semantic version to attach to the base image that was created during the import process. This version follows the semantic version syntax.

      The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

      Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.

      Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

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

      ImportVmImageRequest.Builder description(String description)

      The description for the base image that is created by the import process.

      Parameters:
      description - The description for the base image that is created by the import process.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • platform

      The operating system platform for the imported VM.

      Parameters:
      platform - The operating system platform for the imported VM.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • platform

      The operating system platform for the imported VM.

      Parameters:
      platform - The operating system platform for the imported VM.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • osVersion

      ImportVmImageRequest.Builder osVersion(String osVersion)

      The operating system version for the imported VM.

      Parameters:
      osVersion - The operating system version for the imported VM.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • vmImportTaskId

      ImportVmImageRequest.Builder vmImportTaskId(String vmImportTaskId)

      The importTaskId (API) or ImportTaskId (CLI) from the Amazon EC2 VM import process. Image Builder retrieves information from the import process to pull in the AMI that is created from the VM source as the base image for your recipe.

      Parameters:
      vmImportTaskId - The importTaskId (API) or ImportTaskId (CLI) from the Amazon EC2 VM import process. Image Builder retrieves information from the import process to pull in the AMI that is created from the VM source as the base image for your recipe.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • tags

      Tags that are attached to the import resources.

      Parameters:
      tags - Tags that are attached to the import resources.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • clientToken

      ImportVmImageRequest.Builder clientToken(String clientToken)

      Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

      Parameters:
      clientToken - Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • overrideConfiguration

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

      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.