Package software.amazon.awssdk.services.ec2.model

Interface ImportImageRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<ImportImageRequest.Builder,ImportImageRequest>, Ec2Request.Builder, SdkBuilder<ImportImageRequest.Builder,ImportImageRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ImportImageRequest
public static interface ImportImageRequest.Builder extends Ec2Request.Builder, SdkPojo, CopyableBuilder<ImportImageRequest.Builder,ImportImageRequest>

  • Method Details

    • architecture

      ImportImageRequest.Builder architecture(String architecture)

      The architecture of the virtual machine.

      Valid values: i386 | x86_64

      Parameters:
      architecture - The architecture of the virtual machine.

      Valid values: i386 | x86_64

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

    • clientData

      ImportImageRequest.Builder clientData(ClientData clientData)

      The client-specific data.

      Parameters:
      clientData - The client-specific data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientData

      default ImportImageRequest.Builder clientData(Consumer<ClientData.Builder> clientData)

      The client-specific data.

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

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

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

    • clientToken

      ImportImageRequest.Builder clientToken(String clientToken)

      The token to enable idempotency for VM import requests.

      Parameters:
      clientToken - The token to enable idempotency for VM import requests.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      ImportImageRequest.Builder description(String description)

      A description string for the import image task.

      Parameters:
      description - A description string for the import image task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • diskContainers

      ImportImageRequest.Builder diskContainers(Collection<ImageDiskContainer> diskContainers)

      Information about the disk containers.

      Parameters:
      diskContainers - Information about the disk containers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • diskContainers

      ImportImageRequest.Builder diskContainers(ImageDiskContainer... diskContainers)

      Information about the disk containers.

      Parameters:
      diskContainers - Information about the disk containers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • diskContainers

      ImportImageRequest.Builder diskContainers(Consumer<ImageDiskContainer.Builder>... diskContainers)

      Information about the disk containers.

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

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

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

    • dryRun

      ImportImageRequest.Builder dryRun(Boolean dryRun)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

      Parameters:
      dryRun - Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • encrypted

      ImportImageRequest.Builder encrypted(Boolean encrypted)

      Specifies whether the destination AMI of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

      Parameters:
      encrypted - Specifies whether the destination AMI of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hypervisor

      ImportImageRequest.Builder hypervisor(String hypervisor)

      The target hypervisor platform.

      Valid values: xen

      Parameters:
      hypervisor - The target hypervisor platform.

      Valid values: xen

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

    • kmsKeyId

      ImportImageRequest.Builder kmsKeyId(String kmsKeyId)

      An identifier for the symmetric KMS key to use when creating the encrypted AMI. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

      The KMS key identifier may be provided in any of the following formats:

      • Key ID

      • Key alias

      • ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the key namespace, and then the key ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

      • ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

      Amazon Web Services parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.

      The specified KMS key must exist in the Region that the AMI is being copied to.

      Amazon EBS does not support asymmetric KMS keys.

      Parameters:
      kmsKeyId - An identifier for the symmetric KMS key to use when creating the encrypted AMI. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

      The KMS key identifier may be provided in any of the following formats:

      • Key ID

      • Key alias

      • ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the key namespace, and then the key ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

      • ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

      Amazon Web Services parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.

      The specified KMS key must exist in the Region that the AMI is being copied to.

      Amazon EBS does not support asymmetric KMS keys.

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

    • licenseType

      ImportImageRequest.Builder licenseType(String licenseType)

      The license type to be used for the Amazon Machine Image (AMI) after importing.

      Specify AWS to replace the source-system license with an Amazon Web Services license or BYOL to retain the source-system license. Leaving this parameter undefined is the same as choosing AWS when importing a Windows Server operating system, and the same as choosing BYOL when importing a Windows client operating system (such as Windows 10) or a Linux operating system.

      To use BYOL, you must have existing licenses with rights to use these licenses in a third party cloud, such as Amazon Web Services. For more information, see Prerequisites in the VM Import/Export User Guide.

      Parameters:
      licenseType - The license type to be used for the Amazon Machine Image (AMI) after importing.

      Specify AWS to replace the source-system license with an Amazon Web Services license or BYOL to retain the source-system license. Leaving this parameter undefined is the same as choosing AWS when importing a Windows Server operating system, and the same as choosing BYOL when importing a Windows client operating system (such as Windows 10) or a Linux operating system.

      To use BYOL, you must have existing licenses with rights to use these licenses in a third party cloud, such as Amazon Web Services. For more information, see Prerequisites in the VM Import/Export User Guide.

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

    • platform

      ImportImageRequest.Builder platform(String platform)

      The operating system of the virtual machine. If you import a VM that is compatible with Unified Extensible Firmware Interface (UEFI) using an EBS snapshot, you must specify a value for the platform.

      Valid values: Windows | Linux

      Parameters:
      platform - The operating system of the virtual machine. If you import a VM that is compatible with Unified Extensible Firmware Interface (UEFI) using an EBS snapshot, you must specify a value for the platform.

      Valid values: Windows | Linux

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

    • roleName

      ImportImageRequest.Builder roleName(String roleName)

      The name of the role to use when not using the default role, 'vmimport'.

      Parameters:
      roleName - The name of the role to use when not using the default role, 'vmimport'.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • licenseSpecifications

      ImportImageRequest.Builder licenseSpecifications(Collection<ImportImageLicenseConfigurationRequest> licenseSpecifications)

      The ARNs of the license configurations.

      Parameters:
      licenseSpecifications - The ARNs of the license configurations.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • licenseSpecifications

      ImportImageRequest.Builder licenseSpecifications(ImportImageLicenseConfigurationRequest... licenseSpecifications)

      The ARNs of the license configurations.

      Parameters:
      licenseSpecifications - The ARNs of the license configurations.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • licenseSpecifications

      ImportImageRequest.Builder licenseSpecifications(Consumer<ImportImageLicenseConfigurationRequest.Builder>... licenseSpecifications)

      The ARNs of the license configurations.

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

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

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

    • tagSpecifications

      ImportImageRequest.Builder tagSpecifications(Collection<TagSpecification> tagSpecifications)

      The tags to apply to the import image task during creation.

      Parameters:
      tagSpecifications - The tags to apply to the import image task during creation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tagSpecifications

      ImportImageRequest.Builder tagSpecifications(TagSpecification... tagSpecifications)

      The tags to apply to the import image task during creation.

      Parameters:
      tagSpecifications - The tags to apply to the import image task during creation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tagSpecifications

      ImportImageRequest.Builder tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications)

      The tags to apply to the import image task during creation.

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

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

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

    • usageOperation

      ImportImageRequest.Builder usageOperation(String usageOperation)

      The usage operation value. For more information, see Licensing options in the VM Import/Export User Guide.

      Parameters:
      usageOperation - The usage operation value. For more information, see Licensing options in the VM Import/Export User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • bootMode

      ImportImageRequest.Builder bootMode(String bootMode)

      The boot mode of the virtual machine.

      The uefi-preferred boot mode isn't supported for importing images. For more information, see Boot modes in the VM Import/Export User Guide.

      Parameters:
      bootMode - The boot mode of the virtual machine.

      The uefi-preferred boot mode isn't supported for importing images. For more information, see Boot modes in the VM Import/Export User Guide.

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

    • bootMode

      ImportImageRequest.Builder bootMode(BootModeValues bootMode)

      The boot mode of the virtual machine.

      The uefi-preferred boot mode isn't supported for importing images. For more information, see Boot modes in the VM Import/Export User Guide.

      Parameters:
      bootMode - The boot mode of the virtual machine.

      The uefi-preferred boot mode isn't supported for importing images. For more information, see Boot modes in the VM Import/Export User Guide.

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

    • overrideConfiguration

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

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