com.amazonaws.services.ec2.model

Class ImportImageRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.ImportImageRequest

All Implemented Interfaces:

ReadLimitInfo, DryRunSupportedRequest<ImportImageRequest>, Serializable, Cloneable

public class ImportImageRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<ImportImageRequest>

Container for the parameters to the ImportImage operation.

Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).

See Also:

AmazonEC2.importImage(ImportImageRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ImportImageRequest()

Method Summary

Methods

Modifier and Type	Method and Description
ImportImageRequest	clone()
boolean	equals(Object obj)
String	getArchitecture() The architecture of the virtual machine.
ClientData	getClientData() The client-specific data.
String	getClientToken() The token to enable idempotency for VM import requests.
String	getDescription() A description string for the import image task.
List<ImageDiskContainer>	getDiskContainers() Information about the disk containers.
Request<ImportImageRequest>	getDryRunRequest() This method is intended for internal use only.
String	getHypervisor() The target hypervisor platform.
String	getLicenseType() The license type to be used for the Amazon Machine Image (AMI) after importing.
String	getPlatform() The operating system of the virtual machine.
String	getRoleName() The name of the role to use when not using the default role, 'vmimport'.
int	hashCode()
void	setArchitecture(String architecture) The architecture of the virtual machine.
void	setClientData(ClientData clientData) The client-specific data.
void	setClientToken(String clientToken) The token to enable idempotency for VM import requests.
void	setDescription(String description) A description string for the import image task.
void	setDiskContainers(Collection<ImageDiskContainer> diskContainers) Information about the disk containers.
void	setHypervisor(String hypervisor) The target hypervisor platform.
void	setLicenseType(String licenseType) The license type to be used for the Amazon Machine Image (AMI) after importing.
void	setPlatform(String platform) The operating system of the virtual machine.
void	setRoleName(String roleName) The name of the role to use when not using the default role, 'vmimport'.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ImportImageRequest	withArchitecture(String architecture) The architecture of the virtual machine.
ImportImageRequest	withClientData(ClientData clientData) The client-specific data.
ImportImageRequest	withClientToken(String clientToken) The token to enable idempotency for VM import requests.
ImportImageRequest	withDescription(String description) A description string for the import image task.
ImportImageRequest	withDiskContainers(Collection<ImageDiskContainer> diskContainers) Information about the disk containers.
ImportImageRequest	withDiskContainers(ImageDiskContainer... diskContainers) Information about the disk containers.
ImportImageRequest	withHypervisor(String hypervisor) The target hypervisor platform.
ImportImageRequest	withLicenseType(String licenseType) The license type to be used for the Amazon Machine Image (AMI) after importing.
ImportImageRequest	withPlatform(String platform) The operating system of the virtual machine.
ImportImageRequest	withRoleName(String roleName) The name of the role to use when not using the default role, 'vmimport'.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

ImportImageRequest

public ImportImageRequest()

Method Detail

getDescription

public String getDescription()

A description string for the import image task.

Returns:

A description string for the import image task.

setDescription

public void setDescription(String description)

A description string for the import image task.

Parameters:

description - A description string for the import image task.

withDescription

public ImportImageRequest withDescription(String description)

A description string for the import image task.

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

Parameters:

description - A description string for the import image task.

Returns:

A reference to this updated object so that method calls can be chained together.

getDiskContainers

public List<ImageDiskContainer> getDiskContainers()

Information about the disk containers.

Returns:

Information about the disk containers.

setDiskContainers

public void setDiskContainers(Collection<ImageDiskContainer> diskContainers)

Information about the disk containers.

Parameters:

diskContainers - Information about the disk containers.

withDiskContainers

public ImportImageRequest withDiskContainers(ImageDiskContainer... diskContainers)

Information about the disk containers.

NOTE: This method appends the values to the existing list (if any). Use setDiskContainers(java.util.Collection) or withDiskContainers(java.util.Collection) if you want to override the existing values.

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

Parameters:

diskContainers - Information about the disk containers.

Returns:

A reference to this updated object so that method calls can be chained together.

withDiskContainers

public ImportImageRequest withDiskContainers(Collection<ImageDiskContainer> diskContainers)

Information about the disk containers.

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

Parameters:

diskContainers - Information about the disk containers.

Returns:

A reference to this updated object so that method calls can be chained together.

getLicenseType

public String getLicenseType()

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 VM Import/Export Prerequisites in the Amazon Elastic Compute Cloud User Guide for Linux.

Valid values: AWS | BYOL

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 VM Import/Export Prerequisites in the Amazon Elastic Compute Cloud User Guide for Linux.

Valid values: AWS | BYOL

setLicenseType

public void setLicenseType(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 VM Import/Export Prerequisites in the Amazon Elastic Compute Cloud User Guide for Linux.

Valid values: AWS | BYOL

Parameters:

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 VM Import/Export Prerequisites in the Amazon Elastic Compute Cloud User Guide for Linux.

Valid values: AWS | BYOL

withLicenseType

public ImportImageRequest withLicenseType(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 VM Import/Export Prerequisites in the Amazon Elastic Compute Cloud User Guide for Linux.

Valid values: AWS | BYOL

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

Parameters:

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 VM Import/Export Prerequisites in the Amazon Elastic Compute Cloud User Guide for Linux.

Valid values: AWS | BYOL

Returns:

A reference to this updated object so that method calls can be chained together.

getHypervisor

public String getHypervisor()

The target hypervisor platform.

Valid values: xen

Returns:

The target hypervisor platform.

Valid values: xen

setHypervisor

public void setHypervisor(String hypervisor)

The target hypervisor platform.

Valid values: xen

Parameters:

hypervisor - The target hypervisor platform.

Valid values: xen

withHypervisor

public ImportImageRequest withHypervisor(String hypervisor)

The target hypervisor platform.

Valid values: xen

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

Parameters:

hypervisor - The target hypervisor platform.

Valid values: xen

Returns:

A reference to this updated object so that method calls can be chained together.

getArchitecture

public String getArchitecture()

The architecture of the virtual machine.

Valid values: i386 | x86_64

Returns:

The architecture of the virtual machine.

Valid values: i386 | x86_64

setArchitecture

public void setArchitecture(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

withArchitecture

public ImportImageRequest withArchitecture(String architecture)

The architecture of the virtual machine.

Valid values: i386 | x86_64

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

Parameters:

architecture - The architecture of the virtual machine.

Valid values: i386 | x86_64

Returns:

A reference to this updated object so that method calls can be chained together.

getPlatform

public String getPlatform()

The operating system of the virtual machine.

Valid values: Windows | Linux

Returns:

The operating system of the virtual machine.

Valid values: Windows | Linux

setPlatform

public void setPlatform(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

withPlatform

public ImportImageRequest withPlatform(String platform)

The operating system of the virtual machine.

Valid values: Windows | Linux

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

Parameters:

platform - The operating system of the virtual machine.

Valid values: Windows | Linux

Returns:

A reference to this updated object so that method calls can be chained together.

getClientData

public ClientData getClientData()

The client-specific data.

Returns:

The client-specific data.

setClientData

public void setClientData(ClientData clientData)

The client-specific data.

Parameters:

clientData - The client-specific data.

withClientData

public ImportImageRequest withClientData(ClientData clientData)

The client-specific data.

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

Parameters:

clientData - The client-specific data.

Returns:

A reference to this updated object so that method calls can be chained together.

getClientToken

public String getClientToken()

The token to enable idempotency for VM import requests.

Returns:

The token to enable idempotency for VM import requests.

setClientToken

public void setClientToken(String clientToken)

The token to enable idempotency for VM import requests.

Parameters:

clientToken - The token to enable idempotency for VM import requests.

withClientToken

public ImportImageRequest withClientToken(String clientToken)

The token to enable idempotency for VM import requests.

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

Parameters:

clientToken - The token to enable idempotency for VM import requests.

Returns:

A reference to this updated object so that method calls can be chained together.

getRoleName

public String getRoleName()

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

setRoleName

public void setRoleName(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'.

withRoleName

public ImportImageRequest withRoleName(String roleName)

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

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

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getDryRunRequest

public Request<ImportImageRequest> getDryRunRequest()

This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.

Specified by:

getDryRunRequest in interface DryRunSupportedRequest<ImportImageRequest>

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public ImportImageRequest clone()

Overrides:

clone in class AmazonWebServiceRequest