public class Image
extends java.lang.Object
implements java.io.Serializable
Describes an image.
Constructor and Description |
---|
Image() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getArchitecture()
The architecture of the image.
|
java.util.List<BlockDeviceMapping> |
getBlockDeviceMappings()
Any block device mapping entries.
|
java.lang.String |
getCreationDate()
The date and time the image was created.
|
java.lang.String |
getDescription()
The description of the AMI that was provided during image creation.
|
java.lang.String |
getHypervisor()
The hypervisor type of the image.
|
java.lang.String |
getImageId()
The ID of the AMI.
|
java.lang.String |
getImageLocation()
The location of the AMI.
|
java.lang.String |
getImageOwnerAlias()
The AWS account alias (for example,
amazon ,
self ) or the AWS account ID of the AMI owner. |
java.lang.String |
getImageType()
The type of image.
|
java.lang.String |
getKernelId()
The kernel associated with the image, if any.
|
java.lang.String |
getName()
The name of the AMI that was provided during image creation.
|
java.lang.String |
getOwnerId()
The AWS account ID of the image owner.
|
java.lang.String |
getPlatform()
The value is
Windows for Windows AMIs; otherwise blank. |
java.util.List<ProductCode> |
getProductCodes()
Any product codes associated with the AMI.
|
java.lang.Boolean |
getPublic()
Indicates whether the image has public launch permissions.
|
java.lang.String |
getRamdiskId()
The RAM disk associated with the image, if any.
|
java.lang.String |
getRootDeviceName()
The device name of the root device (for example,
/dev/sda1 or /dev/xvda ). |
java.lang.String |
getRootDeviceType()
The type of root device used by the AMI.
|
java.lang.String |
getSriovNetSupport()
Specifies whether enhanced networking is enabled.
|
java.lang.String |
getState()
The current state of the AMI.
|
StateReason |
getStateReason()
The reason for the state change.
|
java.util.List<Tag> |
getTags()
Any tags assigned to the image.
|
java.lang.String |
getVirtualizationType()
The type of virtualization of the AMI.
|
int |
hashCode() |
java.lang.Boolean |
isPublic()
Indicates whether the image has public launch permissions.
|
void |
setArchitecture(ArchitectureValues architecture)
The architecture of the image.
|
void |
setArchitecture(java.lang.String architecture)
The architecture of the image.
|
void |
setBlockDeviceMappings(java.util.Collection<BlockDeviceMapping> blockDeviceMappings)
Any block device mapping entries.
|
void |
setCreationDate(java.lang.String creationDate)
The date and time the image was created.
|
void |
setDescription(java.lang.String description)
The description of the AMI that was provided during image creation.
|
void |
setHypervisor(HypervisorType hypervisor)
The hypervisor type of the image.
|
void |
setHypervisor(java.lang.String hypervisor)
The hypervisor type of the image.
|
void |
setImageId(java.lang.String imageId)
The ID of the AMI.
|
void |
setImageLocation(java.lang.String imageLocation)
The location of the AMI.
|
void |
setImageOwnerAlias(java.lang.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(java.lang.String imageType)
The type of image.
|
void |
setKernelId(java.lang.String kernelId)
The kernel associated with the image, if any.
|
void |
setName(java.lang.String name)
The name of the AMI that was provided during image creation.
|
void |
setOwnerId(java.lang.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(java.lang.String platform)
The value is
Windows for Windows AMIs; otherwise blank. |
void |
setProductCodes(java.util.Collection<ProductCode> productCodes)
Any product codes associated with the AMI.
|
void |
setPublic(java.lang.Boolean publicValue)
Indicates whether the image has public launch permissions.
|
void |
setRamdiskId(java.lang.String ramdiskId)
The RAM disk associated with the image, if any.
|
void |
setRootDeviceName(java.lang.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(java.lang.String rootDeviceType)
The type of root device used by the AMI.
|
void |
setSriovNetSupport(java.lang.String sriovNetSupport)
Specifies whether enhanced networking is enabled.
|
void |
setState(ImageState state)
The current state of the AMI.
|
void |
setState(java.lang.String state)
The current state of the AMI.
|
void |
setStateReason(StateReason stateReason)
The reason for the state change.
|
void |
setTags(java.util.Collection<Tag> tags)
Any tags assigned to the image.
|
void |
setVirtualizationType(java.lang.String virtualizationType)
The type of virtualization of the AMI.
|
void |
setVirtualizationType(VirtualizationType virtualizationType)
The type of virtualization of the AMI.
|
java.lang.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(java.lang.String architecture)
The architecture of the image.
|
Image |
withBlockDeviceMappings(BlockDeviceMapping... blockDeviceMappings)
Any block device mapping entries.
|
Image |
withBlockDeviceMappings(java.util.Collection<BlockDeviceMapping> blockDeviceMappings)
Any block device mapping entries.
|
Image |
withCreationDate(java.lang.String creationDate)
The date and time the image was created.
|
Image |
withDescription(java.lang.String description)
The description of the AMI that was provided during image creation.
|
Image |
withHypervisor(HypervisorType hypervisor)
The hypervisor type of the image.
|
Image |
withHypervisor(java.lang.String hypervisor)
The hypervisor type of the image.
|
Image |
withImageId(java.lang.String imageId)
The ID of the AMI.
|
Image |
withImageLocation(java.lang.String imageLocation)
The location of the AMI.
|
Image |
withImageOwnerAlias(java.lang.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(java.lang.String imageType)
The type of image.
|
Image |
withKernelId(java.lang.String kernelId)
The kernel associated with the image, if any.
|
Image |
withName(java.lang.String name)
The name of the AMI that was provided during image creation.
|
Image |
withOwnerId(java.lang.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(java.lang.String platform)
The value is
Windows for Windows AMIs; otherwise blank. |
Image |
withProductCodes(java.util.Collection<ProductCode> productCodes)
Any product codes associated with the AMI.
|
Image |
withProductCodes(ProductCode... productCodes)
Any product codes associated with the AMI.
|
Image |
withPublic(java.lang.Boolean publicValue)
Indicates whether the image has public launch permissions.
|
Image |
withRamdiskId(java.lang.String ramdiskId)
The RAM disk associated with the image, if any.
|
Image |
withRootDeviceName(java.lang.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(java.lang.String rootDeviceType)
The type of root device used by the AMI.
|
Image |
withSriovNetSupport(java.lang.String sriovNetSupport)
Specifies whether enhanced networking is enabled.
|
Image |
withState(ImageState state)
The current state of the AMI.
|
Image |
withState(java.lang.String state)
The current state of the AMI.
|
Image |
withStateReason(StateReason stateReason)
The reason for the state change.
|
Image |
withTags(java.util.Collection<Tag> tags)
Any tags assigned to the image.
|
Image |
withTags(Tag... tags)
Any tags assigned to the image.
|
Image |
withVirtualizationType(java.lang.String virtualizationType)
The type of virtualization of the AMI.
|
Image |
withVirtualizationType(VirtualizationType virtualizationType)
The type of virtualization of the AMI.
|
public java.lang.String getImageId()
public void setImageId(java.lang.String imageId)
imageId
- The ID of the AMI.public Image withImageId(java.lang.String imageId)
Returns a reference to this object so that method calls can be chained together.
imageId
- The ID of the AMI.public java.lang.String getImageLocation()
public void setImageLocation(java.lang.String imageLocation)
imageLocation
- The location of the AMI.public Image withImageLocation(java.lang.String imageLocation)
Returns a reference to this object so that method calls can be chained together.
imageLocation
- The location of the AMI.public java.lang.String getState()
available
,
the image is successfully registered and can be used to launch an
instance.
Constraints:
Allowed Values: pending, available, invalid, deregistered, transient, failed, error
available
,
the image is successfully registered and can be used to launch an
instance.ImageState
public void setState(java.lang.String state)
available
,
the image is successfully registered and can be used to launch an
instance.
Constraints:
Allowed Values: pending, available, invalid, deregistered, transient, failed, error
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.ImageState
public Image withState(java.lang.String state)
available
,
the image is successfully registered and can be used to launch an
instance.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: pending, available, invalid, deregistered, transient, failed, error
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.ImageState
public void setState(ImageState state)
available
,
the image is successfully registered and can be used to launch an
instance.
Constraints:
Allowed Values: pending, available, invalid, deregistered, transient, failed, error
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.ImageState
public Image withState(ImageState state)
available
,
the image is successfully registered and can be used to launch an
instance.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: pending, available, invalid, deregistered, transient, failed, error
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.ImageState
public java.lang.String getOwnerId()
public void setOwnerId(java.lang.String ownerId)
ownerId
- The AWS account ID of the image owner.public Image withOwnerId(java.lang.String ownerId)
Returns a reference to this object so that method calls can be chained together.
ownerId
- The AWS account ID of the image owner.public java.lang.String getCreationDate()
public void setCreationDate(java.lang.String creationDate)
creationDate
- The date and time the image was created.public Image withCreationDate(java.lang.String creationDate)
Returns a reference to this object so that method calls can be chained together.
creationDate
- The date and time the image was created.public java.lang.Boolean isPublic()
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 void setPublic(java.lang.Boolean publicValue)
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 Image withPublic(java.lang.Boolean publicValue)
true
if this image has public launch permissions or
false
if it has only implicit and explicit launch
permissions.
Returns a reference to this object so that method calls can be chained together.
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 java.lang.Boolean getPublic()
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 java.util.List<ProductCode> getProductCodes()
public void setProductCodes(java.util.Collection<ProductCode> productCodes)
productCodes
- Any product codes associated with the AMI.public Image withProductCodes(ProductCode... productCodes)
Returns a reference to this object so that method calls can be chained together.
productCodes
- Any product codes associated with the AMI.public Image withProductCodes(java.util.Collection<ProductCode> productCodes)
Returns a reference to this object so that method calls can be chained together.
productCodes
- Any product codes associated with the AMI.public java.lang.String getArchitecture()
Constraints:
Allowed Values: i386, x86_64
ArchitectureValues
public void setArchitecture(java.lang.String architecture)
Constraints:
Allowed Values: i386, x86_64
architecture
- The architecture of the image.ArchitectureValues
public Image withArchitecture(java.lang.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 java.lang.String getImageType()
Constraints:
Allowed Values: machine, kernel, ramdisk
ImageTypeValues
public void setImageType(java.lang.String imageType)
Constraints:
Allowed Values: machine, kernel, ramdisk
imageType
- The type of image.ImageTypeValues
public Image withImageType(java.lang.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.ImageTypeValues
public void setImageType(ImageTypeValues imageType)
Constraints:
Allowed Values: machine, kernel, ramdisk
imageType
- The type of image.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.ImageTypeValues
public java.lang.String getKernelId()
public void setKernelId(java.lang.String kernelId)
kernelId
- The kernel associated with the image, if any. Only applicable for
machine images.public Image withKernelId(java.lang.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 java.lang.String getRamdiskId()
public void setRamdiskId(java.lang.String ramdiskId)
ramdiskId
- The RAM disk associated with the image, if any. Only applicable for
machine images.public Image withRamdiskId(java.lang.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 java.lang.String getPlatform()
Windows
for Windows AMIs; otherwise blank.
Constraints:
Allowed Values: Windows
Windows
for Windows AMIs; otherwise blank.PlatformValues
public void setPlatform(java.lang.String platform)
Windows
for Windows AMIs; otherwise blank.
Constraints:
Allowed Values: Windows
platform
- The value is Windows
for Windows AMIs; otherwise blank.PlatformValues
public Image withPlatform(java.lang.String platform)
Windows
for Windows AMIs; otherwise blank.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: Windows
platform
- The value is Windows
for Windows AMIs; otherwise blank.PlatformValues
public void setPlatform(PlatformValues platform)
Windows
for Windows AMIs; otherwise blank.
Constraints:
Allowed Values: Windows
platform
- The value is Windows
for Windows AMIs; otherwise blank.PlatformValues
public Image withPlatform(PlatformValues platform)
Windows
for Windows AMIs; otherwise blank.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: Windows
platform
- The value is Windows
for Windows AMIs; otherwise blank.PlatformValues
public java.lang.String getSriovNetSupport()
public void setSriovNetSupport(java.lang.String sriovNetSupport)
sriovNetSupport
- Specifies whether enhanced networking is enabled.public Image withSriovNetSupport(java.lang.String sriovNetSupport)
Returns a reference to this object so that method calls can be chained together.
sriovNetSupport
- Specifies whether enhanced networking is enabled.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 java.lang.String getImageOwnerAlias()
amazon
,
self
) or the AWS account ID of the AMI owner.amazon
,
self
) or the AWS account ID of the AMI owner.public void setImageOwnerAlias(java.lang.String imageOwnerAlias)
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 Image withImageOwnerAlias(java.lang.String imageOwnerAlias)
amazon
,
self
) or the AWS account ID of the AMI owner.
Returns a reference to this object so that method calls can be chained together.
imageOwnerAlias
- The AWS account alias (for example, amazon
,
self
) or the AWS account ID of the AMI owner.public java.lang.String getName()
public void setName(java.lang.String name)
name
- The name of the AMI that was provided during image creation.public Image withName(java.lang.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 java.lang.String getDescription()
public void setDescription(java.lang.String description)
description
- The description of the AMI that was provided during image creation.public Image withDescription(java.lang.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 java.lang.String getRootDeviceType()
Constraints:
Allowed Values: ebs, instance-store
DeviceType
public void setRootDeviceType(java.lang.String rootDeviceType)
Constraints:
Allowed Values: ebs, instance-store
rootDeviceType
- The type of root device used by the AMI. The AMI can use an EBS volume
or an instance store volume.DeviceType
public Image withRootDeviceType(java.lang.String rootDeviceType)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: ebs, instance-store
rootDeviceType
- The type of root device used by the AMI. The AMI can use an EBS volume
or an instance store volume.DeviceType
public void setRootDeviceType(DeviceType rootDeviceType)
Constraints:
Allowed Values: ebs, instance-store
rootDeviceType
- The type of root device used by the AMI. The AMI can use an EBS volume
or an instance store volume.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 type of root device used by the AMI. The AMI can use an EBS volume
or an instance store volume.DeviceType
public java.lang.String getRootDeviceName()
/dev/sda1
or /dev/xvda
)./dev/sda1
or /dev/xvda
).public void setRootDeviceName(java.lang.String rootDeviceName)
/dev/sda1
or /dev/xvda
).rootDeviceName
- The device name of the root device (for example,
/dev/sda1
or /dev/xvda
).public Image withRootDeviceName(java.lang.String rootDeviceName)
/dev/sda1
or /dev/xvda
).
Returns a reference to this object so that method calls can be chained together.
rootDeviceName
- The device name of the root device (for example,
/dev/sda1
or /dev/xvda
).public java.util.List<BlockDeviceMapping> getBlockDeviceMappings()
public void setBlockDeviceMappings(java.util.Collection<BlockDeviceMapping> blockDeviceMappings)
blockDeviceMappings
- Any block device mapping entries.public Image withBlockDeviceMappings(BlockDeviceMapping... blockDeviceMappings)
Returns a reference to this object so that method calls can be chained together.
blockDeviceMappings
- Any block device mapping entries.public Image withBlockDeviceMappings(java.util.Collection<BlockDeviceMapping> blockDeviceMappings)
Returns a reference to this object so that method calls can be chained together.
blockDeviceMappings
- Any block device mapping entries.public java.lang.String getVirtualizationType()
Constraints:
Allowed Values: hvm, paravirtual
VirtualizationType
public void setVirtualizationType(java.lang.String virtualizationType)
Constraints:
Allowed Values: hvm, paravirtual
virtualizationType
- The type of virtualization of the AMI.VirtualizationType
public Image withVirtualizationType(java.lang.String virtualizationType)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: hvm, paravirtual
virtualizationType
- The type of virtualization of the AMI.VirtualizationType
public void setVirtualizationType(VirtualizationType virtualizationType)
Constraints:
Allowed Values: hvm, paravirtual
virtualizationType
- The type of virtualization of the AMI.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 type of virtualization of the AMI.VirtualizationType
public java.util.List<Tag> getTags()
public void setTags(java.util.Collection<Tag> tags)
tags
- Any tags assigned to the image.public Image withTags(Tag... tags)
Returns a reference to this object so that method calls can be chained together.
tags
- Any tags assigned to the image.public Image withTags(java.util.Collection<Tag> tags)
Returns a reference to this object so that method calls can be chained together.
tags
- Any tags assigned to the image.public java.lang.String getHypervisor()
Constraints:
Allowed Values: ovm, xen
HypervisorType
public void setHypervisor(java.lang.String hypervisor)
Constraints:
Allowed Values: ovm, xen
hypervisor
- The hypervisor type of the image.HypervisorType
public Image withHypervisor(java.lang.String hypervisor)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: ovm, xen
hypervisor
- The hypervisor type of the image.HypervisorType
public void setHypervisor(HypervisorType hypervisor)
Constraints:
Allowed Values: ovm, xen
hypervisor
- The hypervisor type of the image.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 hypervisor type of the image.HypervisorType
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2018 Amazon Web Services, Inc. All Rights Reserved.