public class Image extends Object implements Serializable
Represents an Amazon Machine Image (AMI) that can be run on an Amazon EC2 instance.
Constructor and Description |
---|
Image() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
String |
getArchitecture()
The architecture of the image.
|
List<BlockDeviceMapping> |
getBlockDeviceMappings()
Specifies how block devices are exposed to the instance.
|
String |
getDescription()
The description of the AMI that was provided during image creation.
|
String |
getHypervisor()
Returns the value of the Hypervisor property for this object.
|
String |
getImageId()
The unique ID of the AMI.
|
String |
getImageLocation()
The location of the AMI.
|
String |
getImageOwnerAlias()
The AWS account alias (e.g., "amazon", "redhat", "self", etc.) or AWS
account ID that owns the AMI.
|
String |
getImageType()
The type of image (machine, kernel, or ramdisk).
|
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()
AWS Access Key ID of the image owner.
|
String |
getPlatform()
The operating platform of the AMI.
|
List<ProductCode> |
getProductCodes()
Product codes of the AMI.
|
Boolean |
getPublic()
True if this image has public launch permissions.
|
String |
getRamdiskId()
The RAM disk associated with the image, if any.
|
String |
getRootDeviceName()
The root device name (e.g.,
/dev/sda1 ). |
String |
getRootDeviceType()
The root device type used by the AMI.
|
String |
getSriovNetSupport()
Returns the value of the SriovNetSupport property for this object.
|
String |
getState()
Current state of the AMI.
|
StateReason |
getStateReason()
The reason for the state change.
|
List<Tag> |
getTags()
A list of tags for the Image.
|
String |
getVirtualizationType()
Returns the value of the VirtualizationType property for this object.
|
int |
hashCode() |
Boolean |
isPublic()
True if this 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)
Specifies how block devices are exposed to the instance.
|
void |
setDescription(String description)
The description of the AMI that was provided during image creation.
|
void |
setHypervisor(HypervisorType hypervisor)
Sets the value of the Hypervisor property for this object.
|
void |
setHypervisor(String hypervisor)
Sets the value of the Hypervisor property for this object.
|
void |
setImageId(String imageId)
The unique ID of the AMI.
|
void |
setImageLocation(String imageLocation)
The location of the AMI.
|
void |
setImageOwnerAlias(String imageOwnerAlias)
The AWS account alias (e.g., "amazon", "redhat", "self", etc.) or AWS
account ID that owns the AMI.
|
void |
setImageType(ImageTypeValues imageType)
The type of image (machine, kernel, or ramdisk).
|
void |
setImageType(String imageType)
The type of image (machine, kernel, or ramdisk).
|
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)
AWS Access Key ID of the image owner.
|
void |
setPlatform(PlatformValues platform)
The operating platform of the AMI.
|
void |
setPlatform(String platform)
The operating platform of the AMI.
|
void |
setProductCodes(Collection<ProductCode> productCodes)
Product codes of the AMI.
|
void |
setPublic(Boolean publicValue)
True if this image has public launch permissions.
|
void |
setRamdiskId(String ramdiskId)
The RAM disk associated with the image, if any.
|
void |
setRootDeviceName(String rootDeviceName)
The root device name (e.g.,
/dev/sda1 ). |
void |
setRootDeviceType(DeviceType rootDeviceType)
The root device type used by the AMI.
|
void |
setRootDeviceType(String rootDeviceType)
The root device type used by the AMI.
|
void |
setSriovNetSupport(String sriovNetSupport)
Sets the value of the SriovNetSupport property for this object.
|
void |
setState(ImageState state)
Current state of the AMI.
|
void |
setState(String state)
Current state of the AMI.
|
void |
setStateReason(StateReason stateReason)
The reason for the state change.
|
void |
setTags(Collection<Tag> tags)
A list of tags for the Image.
|
void |
setVirtualizationType(String virtualizationType)
Sets the value of the VirtualizationType property for this object.
|
void |
setVirtualizationType(VirtualizationType virtualizationType)
Sets the value of the VirtualizationType property for this object.
|
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)
Specifies how block devices are exposed to the instance.
|
Image |
withBlockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)
Specifies how block devices are exposed to the instance.
|
Image |
withDescription(String description)
The description of the AMI that was provided during image creation.
|
Image |
withHypervisor(HypervisorType hypervisor)
Sets the value of the Hypervisor property for this object.
|
Image |
withHypervisor(String hypervisor)
Sets the value of the Hypervisor property for this object.
|
Image |
withImageId(String imageId)
The unique ID of the AMI.
|
Image |
withImageLocation(String imageLocation)
The location of the AMI.
|
Image |
withImageOwnerAlias(String imageOwnerAlias)
The AWS account alias (e.g., "amazon", "redhat", "self", etc.) or AWS
account ID that owns the AMI.
|
Image |
withImageType(ImageTypeValues imageType)
The type of image (machine, kernel, or ramdisk).
|
Image |
withImageType(String imageType)
The type of image (machine, kernel, or ramdisk).
|
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)
AWS Access Key ID of the image owner.
|
Image |
withPlatform(PlatformValues platform)
The operating platform of the AMI.
|
Image |
withPlatform(String platform)
The operating platform of the AMI.
|
Image |
withProductCodes(Collection<ProductCode> productCodes)
Product codes of the AMI.
|
Image |
withProductCodes(ProductCode... productCodes)
Product codes of the AMI.
|
Image |
withPublic(Boolean publicValue)
True if this image has public launch permissions.
|
Image |
withRamdiskId(String ramdiskId)
The RAM disk associated with the image, if any.
|
Image |
withRootDeviceName(String rootDeviceName)
The root device name (e.g.,
/dev/sda1 ). |
Image |
withRootDeviceType(DeviceType rootDeviceType)
The root device type used by the AMI.
|
Image |
withRootDeviceType(String rootDeviceType)
The root device type used by the AMI.
|
Image |
withSriovNetSupport(String sriovNetSupport)
Sets the value of the SriovNetSupport property for this object.
|
Image |
withState(ImageState state)
Current state of the AMI.
|
Image |
withState(String state)
Current state of the AMI.
|
Image |
withStateReason(StateReason stateReason)
The reason for the state change.
|
Image |
withTags(Collection<Tag> tags)
A list of tags for the Image.
|
Image |
withTags(Tag... tags)
A list of tags for the Image.
|
Image |
withVirtualizationType(String virtualizationType)
Sets the value of the VirtualizationType property for this object.
|
Image |
withVirtualizationType(VirtualizationType virtualizationType)
Sets the value of the VirtualizationType property for this object.
|
public String getImageId()
public void setImageId(String imageId)
imageId
- The unique ID of the AMI.public Image withImageId(String imageId)
Returns a reference to this object so that method calls can be chained together.
imageId
- The unique ID of the AMI.public String getImageLocation()
public void setImageLocation(String imageLocation)
imageLocation
- The location of the AMI.public Image withImageLocation(String imageLocation)
Returns a reference to this object so that method calls can be chained together.
imageLocation
- The location of the AMI.public String getState()
Constraints:
Allowed Values: available, deregistered
ImageState
public void setState(String state)
Constraints:
Allowed Values: available, deregistered
state
- Current state of the AMI. If the operation returns available, the
image is successfully registered and available for launching. If the
operation returns deregistered, the image is deregistered and no
longer available for launching.ImageState
public Image withState(String state)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: available, deregistered
state
- Current state of the AMI. If the operation returns available, the
image is successfully registered and available for launching. If the
operation returns deregistered, the image is deregistered and no
longer available for launching.ImageState
public void setState(ImageState state)
Constraints:
Allowed Values: available, deregistered
state
- Current state of the AMI. If the operation returns available, the
image is successfully registered and available for launching. If the
operation returns deregistered, the image is deregistered and no
longer available for launching.ImageState
public Image withState(ImageState state)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: available, deregistered
state
- Current state of the AMI. If the operation returns available, the
image is successfully registered and available for launching. If the
operation returns deregistered, the image is deregistered and no
longer available for launching.ImageState
public String getOwnerId()
public void setOwnerId(String ownerId)
ownerId
- AWS Access Key ID of the image owner.public Image withOwnerId(String ownerId)
Returns a reference to this object so that method calls can be chained together.
ownerId
- AWS Access Key ID of the image owner.public Boolean isPublic()
public void setPublic(Boolean publicValue)
publicValue
- True if this image has public launch permissions. False if it only has
implicit and explicit launch permissions.public Image withPublic(Boolean publicValue)
Returns a reference to this object so that method calls can be chained together.
publicValue
- True if this image has public launch permissions. False if it only has
implicit and explicit launch permissions.public Boolean getPublic()
public List<ProductCode> getProductCodes()
public void setProductCodes(Collection<ProductCode> productCodes)
productCodes
- Product codes of the AMI.public Image withProductCodes(ProductCode... productCodes)
Returns a reference to this object so that method calls can be chained together.
productCodes
- Product codes of the AMI.public Image withProductCodes(Collection<ProductCode> productCodes)
Returns a reference to this object so that method calls can be chained together.
productCodes
- Product codes of the AMI.public String getArchitecture()
Constraints:
Allowed Values: i386, x86_64
ArchitectureValues
public void setArchitecture(String architecture)
Constraints:
Allowed Values: i386, x86_64
architecture
- The architecture of the image.ArchitectureValues
public Image withArchitecture(String architecture)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: i386, x86_64
architecture
- The architecture of the image.ArchitectureValues
public void setArchitecture(ArchitectureValues architecture)
Constraints:
Allowed Values: i386, x86_64
architecture
- The architecture of the image.ArchitectureValues
public Image withArchitecture(ArchitectureValues architecture)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: i386, x86_64
architecture
- The architecture of the image.ArchitectureValues
public String getImageType()
Constraints:
Allowed Values: machine, kernel, ramdisk
ImageTypeValues
public void setImageType(String imageType)
Constraints:
Allowed Values: machine, kernel, ramdisk
imageType
- The type of image (machine, kernel, or ramdisk).ImageTypeValues
public Image withImageType(String imageType)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: machine, kernel, ramdisk
imageType
- The type of image (machine, kernel, or ramdisk).ImageTypeValues
public void setImageType(ImageTypeValues imageType)
Constraints:
Allowed Values: machine, kernel, ramdisk
imageType
- The type of image (machine, kernel, or ramdisk).ImageTypeValues
public Image withImageType(ImageTypeValues imageType)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: machine, kernel, ramdisk
imageType
- The type of image (machine, kernel, or ramdisk).ImageTypeValues
public String getKernelId()
public void setKernelId(String kernelId)
kernelId
- The kernel associated with the image, if any. Only applicable for
machine images.public Image withKernelId(String kernelId)
Returns a reference to this object so that method calls can be chained together.
kernelId
- The kernel associated with the image, if any. Only applicable for
machine images.public String getRamdiskId()
public void setRamdiskId(String ramdiskId)
ramdiskId
- The RAM disk associated with the image, if any. Only applicable for
machine images.public Image withRamdiskId(String ramdiskId)
Returns a reference to this object so that method calls can be chained together.
ramdiskId
- The RAM disk associated with the image, if any. Only applicable for
machine images.public String getPlatform()
Constraints:
Allowed Values: Windows
PlatformValues
public void setPlatform(String platform)
Constraints:
Allowed Values: Windows
platform
- The operating platform of the AMI.PlatformValues
public Image withPlatform(String platform)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: Windows
platform
- The operating platform of the AMI.PlatformValues
public void setPlatform(PlatformValues platform)
Constraints:
Allowed Values: Windows
platform
- The operating platform of the AMI.PlatformValues
public Image withPlatform(PlatformValues platform)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: Windows
platform
- The operating platform of the AMI.PlatformValues
public String getSriovNetSupport()
public void setSriovNetSupport(String sriovNetSupport)
sriovNetSupport
- The new value for the SriovNetSupport property for this object.public Image withSriovNetSupport(String sriovNetSupport)
Returns a reference to this object so that method calls can be chained together.
sriovNetSupport
- The new value for the SriovNetSupport property for this object.public StateReason getStateReason()
public void setStateReason(StateReason stateReason)
stateReason
- The reason for the state change.public Image withStateReason(StateReason stateReason)
Returns a reference to this object so that method calls can be chained together.
stateReason
- The reason for the state change.public String getImageOwnerAlias()
public void setImageOwnerAlias(String imageOwnerAlias)
imageOwnerAlias
- The AWS account alias (e.g., "amazon", "redhat", "self", etc.) or AWS
account ID that owns the AMI.public Image withImageOwnerAlias(String imageOwnerAlias)
Returns a reference to this object so that method calls can be chained together.
imageOwnerAlias
- The AWS account alias (e.g., "amazon", "redhat", "self", etc.) or AWS
account ID that owns the AMI.public String getName()
public void setName(String name)
name
- The name of the AMI that was provided during image creation.public Image withName(String name)
Returns a reference to this object so that method calls can be chained together.
name
- The name of the AMI that was provided during image creation.public String getDescription()
public void setDescription(String description)
description
- The description of the AMI that was provided during image creation.public Image withDescription(String description)
Returns a reference to this object so that method calls can be chained together.
description
- The description of the AMI that was provided during image creation.public String getRootDeviceType()
Constraints:
Allowed Values: ebs, instance-store
DeviceType
public void setRootDeviceType(String rootDeviceType)
Constraints:
Allowed Values: ebs, instance-store
rootDeviceType
- The root device type used by the AMI. The AMI can use an Amazon EBS or
instance store root device.DeviceType
public Image withRootDeviceType(String rootDeviceType)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: ebs, instance-store
rootDeviceType
- The root device type used by the AMI. The AMI can use an Amazon EBS or
instance store root device.DeviceType
public void setRootDeviceType(DeviceType rootDeviceType)
Constraints:
Allowed Values: ebs, instance-store
rootDeviceType
- The root device type used by the AMI. The AMI can use an Amazon EBS or
instance store root device.DeviceType
public Image withRootDeviceType(DeviceType rootDeviceType)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: ebs, instance-store
rootDeviceType
- The root device type used by the AMI. The AMI can use an Amazon EBS or
instance store root device.DeviceType
public String getRootDeviceName()
/dev/sda1
)./dev/sda1
).public void setRootDeviceName(String rootDeviceName)
/dev/sda1
).rootDeviceName
- The root device name (e.g., /dev/sda1
).public Image withRootDeviceName(String rootDeviceName)
/dev/sda1
).
Returns a reference to this object so that method calls can be chained together.
rootDeviceName
- The root device name (e.g., /dev/sda1
).public List<BlockDeviceMapping> getBlockDeviceMappings()
public void setBlockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)
blockDeviceMappings
- Specifies how block devices are exposed to the instance.public Image withBlockDeviceMappings(BlockDeviceMapping... blockDeviceMappings)
Returns a reference to this object so that method calls can be chained together.
blockDeviceMappings
- Specifies how block devices are exposed to the instance.public Image withBlockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)
Returns a reference to this object so that method calls can be chained together.
blockDeviceMappings
- Specifies how block devices are exposed to the instance.public String getVirtualizationType()
Constraints:
Allowed Values: hvm, paravirtual
VirtualizationType
public void setVirtualizationType(String virtualizationType)
Constraints:
Allowed Values: hvm, paravirtual
virtualizationType
- The new value for the VirtualizationType property for this object.VirtualizationType
public Image withVirtualizationType(String virtualizationType)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: hvm, paravirtual
virtualizationType
- The new value for the VirtualizationType property for this object.VirtualizationType
public void setVirtualizationType(VirtualizationType virtualizationType)
Constraints:
Allowed Values: hvm, paravirtual
virtualizationType
- The new value for the VirtualizationType property for this object.VirtualizationType
public Image withVirtualizationType(VirtualizationType virtualizationType)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: hvm, paravirtual
virtualizationType
- The new value for the VirtualizationType property for this object.VirtualizationType
public List<Tag> getTags()
public void setTags(Collection<Tag> tags)
tags
- A list of tags for the Image.public Image withTags(Tag... tags)
Returns a reference to this object so that method calls can be chained together.
tags
- A list of tags for the Image.public Image withTags(Collection<Tag> tags)
Returns a reference to this object so that method calls can be chained together.
tags
- A list of tags for the Image.public String getHypervisor()
Constraints:
Allowed Values: ovm, xen
HypervisorType
public void setHypervisor(String hypervisor)
Constraints:
Allowed Values: ovm, xen
hypervisor
- The new value for the Hypervisor property for this object.HypervisorType
public Image withHypervisor(String hypervisor)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: ovm, xen
hypervisor
- The new value for the Hypervisor property for this object.HypervisorType
public void setHypervisor(HypervisorType hypervisor)
Constraints:
Allowed Values: ovm, xen
hypervisor
- The new value for the Hypervisor property for this object.HypervisorType
public Image withHypervisor(HypervisorType hypervisor)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: ovm, xen
hypervisor
- The new value for the Hypervisor property for this object.HypervisorType
public String toString()
toString
in class Object
Object.toString()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.