public class Image extends Object implements Serializable, Cloneable
Describes an image.
| Constructor and Description |
|---|
Image() |
| Modifier and Type | Method and Description |
|---|---|
Image |
clone() |
boolean |
equals(Object obj) |
String |
getArchitecture()
The architecture of the image.
|
List<BlockDeviceMapping> |
getBlockDeviceMappings()
Any block device mapping entries.
|
String |
getCreationDate()
The date and time the image was created.
|
String |
getDescription()
The description of the AMI that was provided during image creation.
|
Boolean |
getEnaSupport()
Specifies whether enhanced networking with ENA is enabled.
|
String |
getHypervisor()
The hypervisor type of the image.
|
String |
getImageId()
The ID of the AMI.
|
String |
getImageLocation()
The location of the AMI.
|
String |
getImageOwnerAlias()
The AWS account alias (for example,
amazon,
self) or the AWS account ID of the AMI owner. |
String |
getImageType()
The type of image.
|
String |
getKernelId()
The kernel associated with the image, if any.
|
String |
getName()
The name of the AMI that was provided during image creation.
|
String |
getOwnerId()
The AWS account ID of the image owner.
|
String |
getPlatform()
The value is
Windows for Windows AMIs; otherwise blank. |
List<ProductCode> |
getProductCodes()
Any product codes associated with the AMI.
|
Boolean |
getPublic()
Indicates whether the image has public launch permissions.
|
String |
getRamdiskId()
The RAM disk associated with the image, if any.
|
String |
getRootDeviceName()
The device name of the root device (for example,
/dev/sda1
or /dev/xvda). |
String |
getRootDeviceType()
The type of root device used by the AMI.
|
String |
getSriovNetSupport()
Specifies whether enhanced networking with the Intel 82599 Virtual
Function interface is enabled.
|
String |
getState()
The current state of the AMI.
|
StateReason |
getStateReason()
The reason for the state change.
|
List<Tag> |
getTags()
Any tags assigned to the image.
|
String |
getVirtualizationType()
The type of virtualization of the AMI.
|
int |
hashCode() |
Boolean |
isEnaSupport()
Specifies whether enhanced networking with ENA is enabled.
|
Boolean |
isPublic()
Indicates whether the image has public launch permissions.
|
void |
setArchitecture(ArchitectureValues architecture)
The architecture of the image.
|
void |
setArchitecture(String architecture)
The architecture of the image.
|
void |
setBlockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)
Any block device mapping entries.
|
void |
setCreationDate(String creationDate)
The date and time the image was created.
|
void |
setDescription(String description)
The description of the AMI that was provided during image creation.
|
void |
setEnaSupport(Boolean enaSupport)
Specifies whether enhanced networking with ENA is enabled.
|
void |
setHypervisor(HypervisorType hypervisor)
The hypervisor type of the image.
|
void |
setHypervisor(String hypervisor)
The hypervisor type of the image.
|
void |
setImageId(String imageId)
The ID of the AMI.
|
void |
setImageLocation(String imageLocation)
The location of the AMI.
|
void |
setImageOwnerAlias(String imageOwnerAlias)
The AWS account alias (for example,
amazon,
self) or the AWS account ID of the AMI owner. |
void |
setImageType(ImageTypeValues imageType)
The type of image.
|
void |
setImageType(String imageType)
The type of image.
|
void |
setKernelId(String kernelId)
The kernel associated with the image, if any.
|
void |
setName(String name)
The name of the AMI that was provided during image creation.
|
void |
setOwnerId(String ownerId)
The AWS account ID of the image owner.
|
void |
setPlatform(PlatformValues platform)
The value is
Windows for Windows AMIs; otherwise blank. |
void |
setPlatform(String platform)
The value is
Windows for Windows AMIs; otherwise blank. |
void |
setProductCodes(Collection<ProductCode> productCodes)
Any product codes associated with the AMI.
|
void |
setPublic(Boolean publicValue)
Indicates whether the image has public launch permissions.
|
void |
setRamdiskId(String ramdiskId)
The RAM disk associated with the image, if any.
|
void |
setRootDeviceName(String rootDeviceName)
The device name of the root device (for example,
/dev/sda1
or /dev/xvda). |
void |
setRootDeviceType(DeviceType rootDeviceType)
The type of root device used by the AMI.
|
void |
setRootDeviceType(String rootDeviceType)
The type of root device used by the AMI.
|
void |
setSriovNetSupport(String sriovNetSupport)
Specifies whether enhanced networking with the Intel 82599 Virtual
Function interface is enabled.
|
void |
setState(ImageState state)
The current state of the AMI.
|
void |
setState(String state)
The current state of the AMI.
|
void |
setStateReason(StateReason stateReason)
The reason for the state change.
|
void |
setTags(Collection<Tag> tags)
Any tags assigned to the image.
|
void |
setVirtualizationType(String virtualizationType)
The type of virtualization of the AMI.
|
void |
setVirtualizationType(VirtualizationType virtualizationType)
The type of virtualization of the AMI.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
Image |
withArchitecture(ArchitectureValues architecture)
The architecture of the image.
|
Image |
withArchitecture(String architecture)
The architecture of the image.
|
Image |
withBlockDeviceMappings(BlockDeviceMapping... blockDeviceMappings)
Any block device mapping entries.
|
Image |
withBlockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)
Any block device mapping entries.
|
Image |
withCreationDate(String creationDate)
The date and time the image was created.
|
Image |
withDescription(String description)
The description of the AMI that was provided during image creation.
|
Image |
withEnaSupport(Boolean enaSupport)
Specifies whether enhanced networking with ENA is enabled.
|
Image |
withHypervisor(HypervisorType hypervisor)
The hypervisor type of the image.
|
Image |
withHypervisor(String hypervisor)
The hypervisor type of the image.
|
Image |
withImageId(String imageId)
The ID of the AMI.
|
Image |
withImageLocation(String imageLocation)
The location of the AMI.
|
Image |
withImageOwnerAlias(String imageOwnerAlias)
The AWS account alias (for example,
amazon,
self) or the AWS account ID of the AMI owner. |
Image |
withImageType(ImageTypeValues imageType)
The type of image.
|
Image |
withImageType(String imageType)
The type of image.
|
Image |
withKernelId(String kernelId)
The kernel associated with the image, if any.
|
Image |
withName(String name)
The name of the AMI that was provided during image creation.
|
Image |
withOwnerId(String ownerId)
The AWS account ID of the image owner.
|
Image |
withPlatform(PlatformValues platform)
The value is
Windows for Windows AMIs; otherwise blank. |
Image |
withPlatform(String platform)
The value is
Windows for Windows AMIs; otherwise blank. |
Image |
withProductCodes(Collection<ProductCode> productCodes)
Any product codes associated with the AMI.
|
Image |
withProductCodes(ProductCode... productCodes)
Any product codes associated with the AMI.
|
Image |
withPublic(Boolean publicValue)
Indicates whether the image has public launch permissions.
|
Image |
withRamdiskId(String ramdiskId)
The RAM disk associated with the image, if any.
|
Image |
withRootDeviceName(String rootDeviceName)
The device name of the root device (for example,
/dev/sda1
or /dev/xvda). |
Image |
withRootDeviceType(DeviceType rootDeviceType)
The type of root device used by the AMI.
|
Image |
withRootDeviceType(String rootDeviceType)
The type of root device used by the AMI.
|
Image |
withSriovNetSupport(String sriovNetSupport)
Specifies whether enhanced networking with the Intel 82599 Virtual
Function interface is enabled.
|
Image |
withState(ImageState state)
The current state of the AMI.
|
Image |
withState(String state)
The current state of the AMI.
|
Image |
withStateReason(StateReason stateReason)
The reason for the state change.
|
Image |
withTags(Collection<Tag> tags)
Any tags assigned to the image.
|
Image |
withTags(Tag... tags)
Any tags assigned to the image.
|
Image |
withVirtualizationType(String virtualizationType)
The type of virtualization of the AMI.
|
Image |
withVirtualizationType(VirtualizationType virtualizationType)
The type of virtualization of the AMI.
|
public void setImageId(String imageId)
The ID of the AMI.
imageId - The ID of the AMI.public String getImageId()
The ID of the AMI.
public Image withImageId(String imageId)
The ID of the AMI.
imageId - The ID of the AMI.public void setImageLocation(String imageLocation)
The location of the AMI.
imageLocation - The location of the AMI.public String getImageLocation()
The location of the AMI.
public Image withImageLocation(String imageLocation)
The location of the AMI.
imageLocation - The location of the AMI.public void setState(String state)
The current state of the AMI. If the state is available, the
image is successfully registered and can be used to launch an instance.
state - The current state of the AMI. If the state is
available, the image is successfully registered and
can be used to launch an instance.ImageStatepublic String getState()
The current state of the AMI. If the state is available, the
image is successfully registered and can be used to launch an instance.
available, the image is successfully registered and
can be used to launch an instance.ImageStatepublic Image withState(String state)
The current state of the AMI. If the state is available, the
image is successfully registered and can be used to launch an instance.
state - The current state of the AMI. If the state is
available, the image is successfully registered and
can be used to launch an instance.ImageStatepublic void setState(ImageState state)
The current state of the AMI. If the state is available, the
image is successfully registered and can be used to launch an instance.
state - The current state of the AMI. If the state is
available, the image is successfully registered and
can be used to launch an instance.ImageStatepublic Image withState(ImageState state)
The current state of the AMI. If the state is available, the
image is successfully registered and can be used to launch an instance.
state - The current state of the AMI. If the state is
available, the image is successfully registered and
can be used to launch an instance.ImageStatepublic void setOwnerId(String ownerId)
The AWS account ID of the image owner.
ownerId - The AWS account ID of the image owner.public String getOwnerId()
The AWS account ID of the image owner.
public Image withOwnerId(String ownerId)
The AWS account ID of the image owner.
ownerId - The AWS account ID of the image owner.public void setCreationDate(String creationDate)
The date and time the image was created.
creationDate - The date and time the image was created.public String getCreationDate()
The date and time the image was created.
public Image withCreationDate(String creationDate)
The date and time the image was created.
creationDate - The date and time the image was created.public void setPublic(Boolean publicValue)
Indicates whether the image has public launch permissions. The value is
true if this image has public launch permissions or
false if it has only implicit and explicit launch
permissions.
publicValue - Indicates whether the image has public launch permissions. The
value is true if this image has public launch
permissions or false if it has only implicit and
explicit launch permissions.public Boolean getPublic()
Indicates whether the image has public launch permissions. The value is
true if this image has public launch permissions or
false if it has only implicit and explicit launch
permissions.
true if this image has public launch
permissions or false if it has only implicit and
explicit launch permissions.public Image withPublic(Boolean publicValue)
Indicates whether the image has public launch permissions. The value is
true if this image has public launch permissions or
false if it has only implicit and explicit launch
permissions.
publicValue - Indicates whether the image has public launch permissions. The
value is true if this image has public launch
permissions or false if it has only implicit and
explicit launch permissions.public Boolean isPublic()
Indicates whether the image has public launch permissions. The value is
true if this image has public launch permissions or
false if it has only implicit and explicit launch
permissions.
true if this image has public launch
permissions or false if it has only implicit and
explicit launch permissions.public List<ProductCode> getProductCodes()
Any product codes associated with the AMI.
public void setProductCodes(Collection<ProductCode> productCodes)
Any product codes associated with the AMI.
productCodes - Any product codes associated with the AMI.public Image withProductCodes(ProductCode... productCodes)
Any product codes associated with the AMI.
NOTE: This method appends the values to the existing list (if
any). Use setProductCodes(java.util.Collection) or
withProductCodes(java.util.Collection) if you want to override
the existing values.
productCodes - Any product codes associated with the AMI.public Image withProductCodes(Collection<ProductCode> productCodes)
Any product codes associated with the AMI.
productCodes - Any product codes associated with the AMI.public void setArchitecture(String architecture)
The architecture of the image.
architecture - The architecture of the image.ArchitectureValuespublic String getArchitecture()
The architecture of the image.
ArchitectureValuespublic Image withArchitecture(String architecture)
The architecture of the image.
architecture - The architecture of the image.ArchitectureValuespublic void setArchitecture(ArchitectureValues architecture)
The architecture of the image.
architecture - The architecture of the image.ArchitectureValuespublic Image withArchitecture(ArchitectureValues architecture)
The architecture of the image.
architecture - The architecture of the image.ArchitectureValuespublic void setImageType(String imageType)
The type of image.
imageType - The type of image.ImageTypeValuespublic String getImageType()
The type of image.
ImageTypeValuespublic Image withImageType(String imageType)
The type of image.
imageType - The type of image.ImageTypeValuespublic void setImageType(ImageTypeValues imageType)
The type of image.
imageType - The type of image.ImageTypeValuespublic Image withImageType(ImageTypeValues imageType)
The type of image.
imageType - The type of image.ImageTypeValuespublic void setKernelId(String kernelId)
The kernel associated with the image, if any. Only applicable for machine images.
kernelId - The kernel associated with the image, if any. Only applicable for
machine images.public String getKernelId()
The kernel associated with the image, if any. Only applicable for machine images.
public Image withKernelId(String kernelId)
The kernel associated with the image, if any. Only applicable for machine images.
kernelId - The kernel associated with the image, if any. Only applicable for
machine images.public void setRamdiskId(String ramdiskId)
The RAM disk associated with the image, if any. Only applicable for machine images.
ramdiskId - The RAM disk associated with the image, if any. Only applicable
for machine images.public String getRamdiskId()
The RAM disk associated with the image, if any. Only applicable for machine images.
public Image withRamdiskId(String ramdiskId)
The RAM disk associated with the image, if any. Only applicable for machine images.
ramdiskId - The RAM disk associated with the image, if any. Only applicable
for machine images.public void setPlatform(String platform)
The value is Windows for Windows AMIs; otherwise blank.
platform - The value is Windows for Windows AMIs; otherwise
blank.PlatformValuespublic String getPlatform()
The value is Windows for Windows AMIs; otherwise blank.
Windows for Windows AMIs; otherwise
blank.PlatformValuespublic Image withPlatform(String platform)
The value is Windows for Windows AMIs; otherwise blank.
platform - The value is Windows for Windows AMIs; otherwise
blank.PlatformValuespublic void setPlatform(PlatformValues platform)
The value is Windows for Windows AMIs; otherwise blank.
platform - The value is Windows for Windows AMIs; otherwise
blank.PlatformValuespublic Image withPlatform(PlatformValues platform)
The value is Windows for Windows AMIs; otherwise blank.
platform - The value is Windows for Windows AMIs; otherwise
blank.PlatformValuespublic void setSriovNetSupport(String sriovNetSupport)
Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
sriovNetSupport - Specifies whether enhanced networking with the Intel 82599 Virtual
Function interface is enabled.public String getSriovNetSupport()
Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
public Image withSriovNetSupport(String sriovNetSupport)
Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
sriovNetSupport - Specifies whether enhanced networking with the Intel 82599 Virtual
Function interface is enabled.public void setEnaSupport(Boolean enaSupport)
Specifies whether enhanced networking with ENA is enabled.
enaSupport - Specifies whether enhanced networking with ENA is enabled.public Boolean getEnaSupport()
Specifies whether enhanced networking with ENA is enabled.
public Image withEnaSupport(Boolean enaSupport)
Specifies whether enhanced networking with ENA is enabled.
enaSupport - Specifies whether enhanced networking with ENA is enabled.public Boolean isEnaSupport()
Specifies whether enhanced networking with ENA is enabled.
public void setStateReason(StateReason stateReason)
The reason for the state change.
stateReason - The reason for the state change.public StateReason getStateReason()
The reason for the state change.
public Image withStateReason(StateReason stateReason)
The reason for the state change.
stateReason - The reason for the state change.public void setImageOwnerAlias(String imageOwnerAlias)
The AWS account alias (for example, amazon,
self) or the AWS account ID of the AMI owner.
imageOwnerAlias - The AWS account alias (for example, amazon,
self) or the AWS account ID of the AMI owner.public String getImageOwnerAlias()
The AWS account alias (for example, amazon,
self) or the AWS account ID of the AMI owner.
amazon,
self) or the AWS account ID of the AMI owner.public Image withImageOwnerAlias(String imageOwnerAlias)
The AWS account alias (for example, amazon,
self) or the AWS account ID of the AMI owner.
imageOwnerAlias - The AWS account alias (for example, amazon,
self) or the AWS account ID of the AMI owner.public void setName(String name)
The name of the AMI that was provided during image creation.
name - The name of the AMI that was provided during image creation.public String getName()
The name of the AMI that was provided during image creation.
public Image withName(String name)
The name of the AMI that was provided during image creation.
name - The name of the AMI that was provided during image creation.public void setDescription(String description)
The description of the AMI that was provided during image creation.
description - The description of the AMI that was provided during image
creation.public String getDescription()
The description of the AMI that was provided during image creation.
public Image withDescription(String description)
The description of the AMI that was provided during image creation.
description - The description of the AMI that was provided during image
creation.public void setRootDeviceType(String rootDeviceType)
The type of root device used by the AMI. The AMI can use an EBS volume or an instance store volume.
rootDeviceType - The type of root device used by the AMI. The AMI can use an EBS
volume or an instance store volume.DeviceTypepublic String getRootDeviceType()
The type of root device used by the AMI. The AMI can use an EBS volume or an instance store volume.
DeviceTypepublic Image withRootDeviceType(String rootDeviceType)
The type of root device used by the AMI. The AMI can use an EBS volume or an instance store volume.
rootDeviceType - The type of root device used by the AMI. The AMI can use an EBS
volume or an instance store volume.DeviceTypepublic void setRootDeviceType(DeviceType rootDeviceType)
The type of root device used by the AMI. The AMI can use an EBS volume or an instance store volume.
rootDeviceType - The type of root device used by the AMI. The AMI can use an EBS
volume or an instance store volume.DeviceTypepublic Image withRootDeviceType(DeviceType rootDeviceType)
The type of root device used by the AMI. The AMI can use an EBS volume or an instance store volume.
rootDeviceType - The type of root device used by the AMI. The AMI can use an EBS
volume or an instance store volume.DeviceTypepublic void setRootDeviceName(String rootDeviceName)
The device name of the root device (for example, /dev/sda1
or /dev/xvda).
rootDeviceName - The device name of the root device (for example,
/dev/sda1 or /dev/xvda).public String getRootDeviceName()
The device name of the root device (for example, /dev/sda1
or /dev/xvda).
/dev/sda1 or /dev/xvda).public Image withRootDeviceName(String rootDeviceName)
The device name of the root device (for example, /dev/sda1
or /dev/xvda).
rootDeviceName - The device name of the root device (for example,
/dev/sda1 or /dev/xvda).public List<BlockDeviceMapping> getBlockDeviceMappings()
Any block device mapping entries.
public void setBlockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)
Any block device mapping entries.
blockDeviceMappings - Any block device mapping entries.public Image withBlockDeviceMappings(BlockDeviceMapping... blockDeviceMappings)
Any block device mapping entries.
NOTE: This method appends the values to the existing list (if
any). Use setBlockDeviceMappings(java.util.Collection) or
withBlockDeviceMappings(java.util.Collection) if you want to
override the existing values.
blockDeviceMappings - Any block device mapping entries.public Image withBlockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)
Any block device mapping entries.
blockDeviceMappings - Any block device mapping entries.public void setVirtualizationType(String virtualizationType)
The type of virtualization of the AMI.
virtualizationType - The type of virtualization of the AMI.VirtualizationTypepublic String getVirtualizationType()
The type of virtualization of the AMI.
VirtualizationTypepublic Image withVirtualizationType(String virtualizationType)
The type of virtualization of the AMI.
virtualizationType - The type of virtualization of the AMI.VirtualizationTypepublic void setVirtualizationType(VirtualizationType virtualizationType)
The type of virtualization of the AMI.
virtualizationType - The type of virtualization of the AMI.VirtualizationTypepublic Image withVirtualizationType(VirtualizationType virtualizationType)
The type of virtualization of the AMI.
virtualizationType - The type of virtualization of the AMI.VirtualizationTypepublic List<Tag> getTags()
Any tags assigned to the image.
public void setTags(Collection<Tag> tags)
Any tags assigned to the image.
tags - Any tags assigned to the image.public Image withTags(Tag... tags)
Any tags assigned to the image.
NOTE: This method appends the values to the existing list (if
any). Use setTags(java.util.Collection) or
withTags(java.util.Collection) if you want to override the
existing values.
tags - Any tags assigned to the image.public Image withTags(Collection<Tag> tags)
Any tags assigned to the image.
tags - Any tags assigned to the image.public void setHypervisor(String hypervisor)
The hypervisor type of the image.
hypervisor - The hypervisor type of the image.HypervisorTypepublic String getHypervisor()
The hypervisor type of the image.
HypervisorTypepublic Image withHypervisor(String hypervisor)
The hypervisor type of the image.
hypervisor - The hypervisor type of the image.HypervisorTypepublic void setHypervisor(HypervisorType hypervisor)
The hypervisor type of the image.
hypervisor - The hypervisor type of the image.HypervisorTypepublic Image withHypervisor(HypervisorType hypervisor)
The hypervisor type of the image.
hypervisor - The hypervisor type of the image.HypervisorTypepublic String toString()
toString in class ObjectObject.toString()Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.