Interface ImportVmImageRequest.Builder

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

  • Method Details

    • name

      ImportVmImageRequest.Builder name(String name)

      The name of the base image that is created by the import process. Image Builder generates the image ARN from a normalized form of the name, so names that differ only in case, spaces, or underscores count as the same name. If an image with the same name and semantic version already exists in your account in the same Amazon Web Services Region, the import creates a new build version for it.

      Parameters:
      name - The name of the base image that is created by the import process. Image Builder generates the image ARN from a normalized form of the name, so names that differ only in case, spaces, or underscores count as the same name. If an image with the same name and semantic version already exists in your account in the same Amazon Web Services Region, the import creates a new build version for it.
      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. The upper limit is 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. The upper limit is 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

      ImportVmImageRequest.Builder platform(String 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

      ImportVmImageRequest.Builder platform(Platform 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. The import task doesn't need to be complete when you call ImportVmImage - Image Builder monitors the task and finishes creating the image when the task completes.

      Parameters:
      vmImportTaskId - The importTaskId (API) or ImportTaskId (CLI) from the Amazon EC2 VM import process. The import task doesn't need to be complete when you call ImportVmImage - Image Builder monitors the task and finishes creating the image when the task completes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • loggingConfiguration

      ImportVmImageRequest.Builder loggingConfiguration(ImageLoggingConfiguration loggingConfiguration)

      The CloudWatch Logs log group where Image Builder sends the import logs. For ImportVmImage, the log group name must be within the /aws/imagebuilder/ namespace.

      Parameters:
      loggingConfiguration - The CloudWatch Logs log group where Image Builder sends the import logs. For ImportVmImage, the log group name must be within the /aws/imagebuilder/ namespace.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • loggingConfiguration

      default ImportVmImageRequest.Builder loggingConfiguration(Consumer<ImageLoggingConfiguration.Builder> loggingConfiguration)

      The CloudWatch Logs log group where Image Builder sends the import logs. For ImportVmImage, the log group name must be within the /aws/imagebuilder/ namespace.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to loggingConfiguration(ImageLoggingConfiguration).

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

    • tags

      ImportVmImageRequest.Builder tags(Map<String,String> 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)

      A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

      Parameters:
      clientToken - A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. 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

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