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 Summary

Modifier and Type	Method and Description
ImportImageRequest.Builder	architecture(String architecture) The architecture of the virtual machine.
ImportImageRequest.Builder	clientData(ClientData clientData) The client-specific data.
default ImportImageRequest.Builder	clientData(Consumer<ClientData.Builder> clientData) The client-specific data.
ImportImageRequest.Builder	clientToken(String clientToken) The token to enable idempotency for VM import requests.
ImportImageRequest.Builder	description(String description) A description string for the import image task.
ImportImageRequest.Builder	diskContainers(Collection<ImageDiskContainer> diskContainers) Information about the disk containers.
ImportImageRequest.Builder	diskContainers(Consumer<ImageDiskContainer.Builder>... diskContainers) Information about the disk containers.
ImportImageRequest.Builder	diskContainers(ImageDiskContainer... diskContainers) Information about the disk containers.
ImportImageRequest.Builder	encrypted(Boolean encrypted) Specifies whether the destination AMI of the imported image should be encrypted.
ImportImageRequest.Builder	hypervisor(String hypervisor) The target hypervisor platform.
ImportImageRequest.Builder	kmsKeyId(String kmsKeyId) An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted AMI.
ImportImageRequest.Builder	licenseType(String licenseType) The license type to be used for the Amazon Machine Image (AMI) after importing.
ImportImageRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
ImportImageRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
ImportImageRequest.Builder	platform(String platform) The operating system of the virtual machine.
ImportImageRequest.Builder	roleName(String roleName) The name of the role to use when not using the default role, 'vmimport'.

Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

architecture

ImportImageRequest.Builder architecture(String architecture)

The architecture of the virtual machine.

Valid values: i386 | x86_64 | arm64

Parameters:

architecture - The architecture of the virtual machine.

Valid values: i386 | x86_64 | arm64

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 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:

clientData(ClientData)

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 that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #diskContainers(List).

Parameters:

diskContainers - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#diskContainers(List)

encrypted

ImportImageRequest.Builder encrypted(Boolean encrypted)

Specifies whether the destination AMI of the imported image should be encrypted. The default CMK for EBS is used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK 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 CMK for EBS is used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK 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 AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted AMI. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

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

• Key ID

• Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

• ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK 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 CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS 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 CMK must exist in the Region that the AMI is being copied to.

Parameters:

kmsKeyId - An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted AMI. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

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

• Key ID

• Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

• ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK 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 CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS 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 CMK must exist in the Region that the AMI is being copied to.

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.

By default, we detect the source-system operating system (OS) and apply the appropriate license. Specify AWS to replace the source-system license with an AWS license, if appropriate. Specify BYOL to retain the source-system license, if appropriate.

To use BYOL, you must have existing licenses with rights to use these licenses in a third party cloud, such as AWS. 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.

By default, we detect the source-system operating system (OS) and apply the appropriate license. Specify AWS to replace the source-system license with an AWS license, if appropriate. Specify BYOL to retain the source-system license, if appropriate.

To use BYOL, you must have existing licenses with rights to use these licenses in a third party cloud, such as AWS. 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.

Valid values: Windows | Linux

Parameters:

platform - The operating system of the virtual machine.

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.

overrideConfiguration

ImportImageRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

ImportImageRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder