software.amazon.awssdk.services.ec2.model

Class ImportImageRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ec2.model.Ec2Request

software.amazon.awssdk.services.ec2.model.ImportImageRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ImportImageRequest.Builder,ImportImageRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ImportImageRequest
extends Ec2Request
implements ToCopyableBuilder<ImportImageRequest.Builder,ImportImageRequest>

Contains the parameters for ImportImage.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ImportImageRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	architecture() The architecture of the virtual machine.
static ImportImageRequest.Builder	builder()
ClientData	clientData() The client-specific data.
String	clientToken() The token to enable idempotency for VM import requests.
String	description() A description string for the import image task.
List<ImageDiskContainer>	diskContainers() Information about the disk containers.
Boolean	encrypted() Specifies whether the destination AMI of the imported image should be encrypted.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	hypervisor() The target hypervisor platform.
String	kmsKeyId() An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted AMI.
String	licenseType() The license type to be used for the Amazon Machine Image (AMI) after importing.
String	platform() The operating system of the virtual machine.
String	roleName() The name of the role to use when not using the default role, 'vmimport'.
List<SdkField<?>>	sdkFields()
static Class<? extends ImportImageRequest.Builder>	serializableBuilderClass()
ImportImageRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

architecture

public String architecture()

The architecture of the virtual machine.

Valid values: i386 | x86_64 | arm64

Returns:

The architecture of the virtual machine.

Valid values: i386 | x86_64 | arm64

clientData

public ClientData clientData()

The client-specific data.

Returns:

The client-specific data.

clientToken

public String clientToken()

The token to enable idempotency for VM import requests.

Returns:

The token to enable idempotency for VM import requests.

description

public String description()

A description string for the import image task.

Returns:

A description string for the import image task.

diskContainers

public List<ImageDiskContainer> diskContainers()

Information about the disk containers.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Information about the disk containers.

encrypted

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

Returns:

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.

hypervisor

public String hypervisor()

The target hypervisor platform.

Valid values: xen

Returns:

The target hypervisor platform.

Valid values: xen

kmsKeyId

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

Returns:

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.

licenseType

public String licenseType()

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

Note: You may only use BYOL if you have existing licenses with rights to use these licenses in a third party cloud like AWS. For more information, see Prerequisites in the VM Import/Export User Guide.

Valid values include:

• Auto - Detects the source-system operating system (OS) and applies the appropriate license.

• AWS - Replaces the source-system license with an AWS license, if appropriate.

• BYOL - Retains the source-system license, if appropriate.

Default value: Auto

Returns:

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

Note: You may only use BYOL if you have existing licenses with rights to use these licenses in a third party cloud like AWS. For more information, see Prerequisites in the VM Import/Export User Guide.

Valid values include:

• Auto - Detects the source-system operating system (OS) and applies the appropriate license.

• AWS - Replaces the source-system license with an AWS license, if appropriate.

• BYOL - Retains the source-system license, if appropriate.

Default value: Auto

platform

public String platform()

The operating system of the virtual machine.

Valid values: Windows | Linux

Returns:

The operating system of the virtual machine.

Valid values: Windows | Linux

roleName

public String roleName()

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

Returns:

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

toBuilder

public ImportImageRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ImportImageRequest.Builder,ImportImageRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static ImportImageRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ImportImageRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo