Interface ImportDiskImageRequest.Builder

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

  • Method Details

    • name

      ImportDiskImageRequest.Builder name(String name)

      The name of the image resource that's created from the import. 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 image resource that's created from the import. 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

      ImportDiskImageRequest.Builder semanticVersion(String semanticVersion)

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

      Parameters:
      semanticVersion - The semantic version to attach to the image that's created during the import process. This version follows the semantic version syntax.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      ImportDiskImageRequest.Builder description(String description)

      The description for your disk image import.

      Parameters:
      description - The description for your disk image import.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • platform

      ImportDiskImageRequest.Builder platform(String platform)

      The operating system platform for the imported image. Allowed values include the following: Windows.

      Parameters:
      platform - The operating system platform for the imported image. Allowed values include the following: Windows.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • osVersion

      ImportDiskImageRequest.Builder osVersion(String osVersion)

      The operating system version for the imported image. The only supported value is Microsoft Windows 11.

      Parameters:
      osVersion - The operating system version for the imported image. The only supported value is Microsoft Windows 11.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • executionRole

      ImportDiskImageRequest.Builder executionRole(String executionRole)

      The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions to import an image from a Microsoft ISO file. If you don't provide a role, Image Builder uses the Image Builder service-linked role in your account, and creates it if it doesn't exist.

      Parameters:
      executionRole - The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions to import an image from a Microsoft ISO file. If you don't provide a role, Image Builder uses the Image Builder service-linked role in your account, and creates it if it doesn't exist.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • infrastructureConfigurationArn

      ImportDiskImageRequest.Builder infrastructureConfigurationArn(String infrastructureConfigurationArn)

      The Amazon Resource Name (ARN) of the infrastructure configuration resource that's used for launching the EC2 instance on which the ISO image is built.

      Parameters:
      infrastructureConfigurationArn - The Amazon Resource Name (ARN) of the infrastructure configuration resource that's used for launching the EC2 instance on which the ISO image is built.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • uri

      ImportDiskImageRequest.Builder uri(String uri)

      The uri of the ISO disk file that's stored in Amazon S3, in s3://bucket/key format. The key must end with the .iso, .ISO, or .Iso extension, and the bucket must be owned by the account that makes the request.

      Parameters:
      uri - The uri of the ISO disk file that's stored in Amazon S3, in s3://bucket/key format. The key must end with the .iso, .ISO, or .Iso extension, and the bucket must be owned by the account that makes the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • loggingConfiguration

      ImportDiskImageRequest.Builder loggingConfiguration(ImageLoggingConfiguration loggingConfiguration)

      The CloudWatch Logs log group where Image Builder sends the import logs. If you specify a log group name outside of the /aws/imagebuilder/ namespace, you must also provide an executionRole that has permission to write to that log group.

      Parameters:
      loggingConfiguration - The CloudWatch Logs log group where Image Builder sends the import logs. If you specify a log group name outside of the /aws/imagebuilder/ namespace, you must also provide an executionRole that has permission to write to that log group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • loggingConfiguration

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

      The CloudWatch Logs log group where Image Builder sends the import logs. If you specify a log group name outside of the /aws/imagebuilder/ namespace, you must also provide an executionRole that has permission to write to that log group.

      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

      ImportDiskImageRequest.Builder tags(Map<String,String> tags)

      Tags that are attached to image resources created from the import.

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

    • registerImageOptions

      ImportDiskImageRequest.Builder registerImageOptions(RegisterImageOptions registerImageOptions)

      Configures Secure Boot and UEFI settings for the imported image.

      Parameters:
      registerImageOptions - Configures Secure Boot and UEFI settings for the imported image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • registerImageOptions

      default ImportDiskImageRequest.Builder registerImageOptions(Consumer<RegisterImageOptions.Builder> registerImageOptions)

      Configures Secure Boot and UEFI settings for the imported image.

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

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

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

    • windowsConfiguration

      ImportDiskImageRequest.Builder windowsConfiguration(WindowsConfiguration windowsConfiguration)

      Specifies Windows settings for ISO imports.

      Parameters:
      windowsConfiguration - Specifies Windows settings for ISO imports.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • windowsConfiguration

      default ImportDiskImageRequest.Builder windowsConfiguration(Consumer<WindowsConfiguration.Builder> windowsConfiguration)

      Specifies Windows settings for ISO imports.

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

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

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

    • clientToken

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

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

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