Class Image

java.lang.Object
com.amazonaws.services.ec2.model.Image
All Implemented Interfaces:
Serializable, Cloneable
public class Image extends Object implements Serializable, Cloneable

Describes an image.

See Also:

  • Constructor Details

    • Image

      public Image()

  • Method Details

    • setImageId

      public void setImageId(String imageId)

      The ID of the AMI.

      Parameters:
      imageId - The ID of the AMI.

    • getImageId

      public String getImageId()

      The ID of the AMI.

      Returns:
      The ID of the AMI.

    • withImageId

      public Image withImageId(String imageId)

      The ID of the AMI.

      Parameters:
      imageId - The ID of the AMI.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setImageLocation

      public void setImageLocation(String imageLocation)

      The location of the AMI.

      Parameters:
      imageLocation - The location of the AMI.

    • getImageLocation

      public String getImageLocation()

      The location of the AMI.

      Returns:
      The location of the AMI.

    • withImageLocation

      public Image withImageLocation(String imageLocation)

      The location of the AMI.

      Parameters:
      imageLocation - The location of the AMI.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setState

      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.

      Parameters:
      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.
      See Also:

    • getState

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

      Returns:
      The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.
      See Also:

    • withState

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

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • setState

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

      Parameters:
      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.
      See Also:

    • withState

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

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • setOwnerId

      public void setOwnerId(String ownerId)

      The AWS account ID of the image owner.

      Parameters:
      ownerId - The AWS account ID of the image owner.

    • getOwnerId

      public String getOwnerId()

      The AWS account ID of the image owner.

      Returns:
      The AWS account ID of the image owner.

    • withOwnerId

      public Image withOwnerId(String ownerId)

      The AWS account ID of the image owner.

      Parameters:
      ownerId - The AWS account ID of the image owner.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setCreationDate

      public void setCreationDate(String creationDate)

      The date and time the image was created.

      Parameters:
      creationDate - The date and time the image was created.

    • getCreationDate

      public String getCreationDate()

      The date and time the image was created.

      Returns:
      The date and time the image was created.

    • withCreationDate

      public Image withCreationDate(String creationDate)

      The date and time the image was created.

      Parameters:
      creationDate - The date and time the image was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setPublic

      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.

      Parameters:
      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.

    • getPublic

      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.

      Returns:
      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.

    • withPublic

      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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • isPublic

      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.

      Returns:
      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.

    • getProductCodes

      public List<ProductCode> getProductCodes()

      Any product codes associated with the AMI.

      Returns:
      Any product codes associated with the AMI.

    • setProductCodes

      public void setProductCodes(Collection<ProductCode> productCodes)

      Any product codes associated with the AMI.

      Parameters:
      productCodes - Any product codes associated with the AMI.

    • withProductCodes

      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.

      Parameters:
      productCodes - Any product codes associated with the AMI.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • withProductCodes

      public Image withProductCodes(Collection<ProductCode> productCodes)

      Any product codes associated with the AMI.

      Parameters:
      productCodes - Any product codes associated with the AMI.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setArchitecture

      public void setArchitecture(String architecture)

      The architecture of the image.

      Parameters:
      architecture - The architecture of the image.
      See Also:

    • getArchitecture

      public String getArchitecture()

      The architecture of the image.

      Returns:
      The architecture of the image.
      See Also:

    • withArchitecture

      public Image withArchitecture(String architecture)

      The architecture of the image.

      Parameters:
      architecture - The architecture of the image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • setArchitecture

      public void setArchitecture(ArchitectureValues architecture)

      The architecture of the image.

      Parameters:
      architecture - The architecture of the image.
      See Also:

    • withArchitecture

      public Image withArchitecture(ArchitectureValues architecture)

      The architecture of the image.

      Parameters:
      architecture - The architecture of the image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • setImageType

      public void setImageType(String imageType)

      The type of image.

      Parameters:
      imageType - The type of image.
      See Also:

    • getImageType

      public String getImageType()

      The type of image.

      Returns:
      The type of image.
      See Also:

    • withImageType

      public Image withImageType(String imageType)

      The type of image.

      Parameters:
      imageType - The type of image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • setImageType

      public void setImageType(ImageTypeValues imageType)

      The type of image.

      Parameters:
      imageType - The type of image.
      See Also:

    • withImageType

      public Image withImageType(ImageTypeValues imageType)

      The type of image.

      Parameters:
      imageType - The type of image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • setKernelId

      public void setKernelId(String kernelId)

      The kernel associated with the image, if any. Only applicable for machine images.

      Parameters:
      kernelId - The kernel associated with the image, if any. Only applicable for machine images.

    • getKernelId

      public String getKernelId()

      The kernel associated with the image, if any. Only applicable for machine images.

      Returns:
      The kernel associated with the image, if any. Only applicable for machine images.

    • withKernelId

      public Image withKernelId(String kernelId)

      The kernel associated with the image, if any. Only applicable for machine images.

      Parameters:
      kernelId - The kernel associated with the image, if any. Only applicable for machine images.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setRamdiskId

      public void setRamdiskId(String ramdiskId)

      The RAM disk associated with the image, if any. Only applicable for machine images.

      Parameters:
      ramdiskId - The RAM disk associated with the image, if any. Only applicable for machine images.

    • getRamdiskId

      public String getRamdiskId()

      The RAM disk associated with the image, if any. Only applicable for machine images.

      Returns:
      The RAM disk associated with the image, if any. Only applicable for machine images.

    • withRamdiskId

      public Image withRamdiskId(String ramdiskId)

      The RAM disk associated with the image, if any. Only applicable for machine images.

      Parameters:
      ramdiskId - The RAM disk associated with the image, if any. Only applicable for machine images.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setPlatform

      public void setPlatform(String platform)

      The value is Windows for Windows AMIs; otherwise blank.

      Parameters:
      platform - The value is Windows for Windows AMIs; otherwise blank.
      See Also:

    • getPlatform

      public String getPlatform()

      The value is Windows for Windows AMIs; otherwise blank.

      Returns:
      The value is Windows for Windows AMIs; otherwise blank.
      See Also:

    • withPlatform

      public Image withPlatform(String platform)

      The value is Windows for Windows AMIs; otherwise blank.

      Parameters:
      platform - The value is Windows for Windows AMIs; otherwise blank.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • setPlatform

      public void setPlatform(PlatformValues platform)

      The value is Windows for Windows AMIs; otherwise blank.

      Parameters:
      platform - The value is Windows for Windows AMIs; otherwise blank.
      See Also:

    • withPlatform

      public Image withPlatform(PlatformValues platform)

      The value is Windows for Windows AMIs; otherwise blank.

      Parameters:
      platform - The value is Windows for Windows AMIs; otherwise blank.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • setSriovNetSupport

      public void setSriovNetSupport(String sriovNetSupport)

      Specifies whether enhanced networking is enabled.

      Parameters:
      sriovNetSupport - Specifies whether enhanced networking is enabled.

    • getSriovNetSupport

      public String getSriovNetSupport()

      Specifies whether enhanced networking is enabled.

      Returns:
      Specifies whether enhanced networking is enabled.

    • withSriovNetSupport

      public Image withSriovNetSupport(String sriovNetSupport)

      Specifies whether enhanced networking is enabled.

      Parameters:
      sriovNetSupport - Specifies whether enhanced networking is enabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setStateReason

      public void setStateReason(StateReason stateReason)

      The reason for the state change.

      Parameters:
      stateReason - The reason for the state change.

    • getStateReason

      public StateReason getStateReason()

      The reason for the state change.

      Returns:
      The reason for the state change.

    • withStateReason

      public Image withStateReason(StateReason stateReason)

      The reason for the state change.

      Parameters:
      stateReason - The reason for the state change.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setImageOwnerAlias

      public void setImageOwnerAlias(String imageOwnerAlias)

      The AWS account alias (for example, amazon, self) or the AWS account ID of the AMI owner.

      Parameters:
      imageOwnerAlias - The AWS account alias (for example, amazon, self) or the AWS account ID of the AMI owner.

    • getImageOwnerAlias

      public String getImageOwnerAlias()

      The AWS account alias (for example, amazon, self) or the AWS account ID of the AMI owner.

      Returns:
      The AWS account alias (for example, amazon, self) or the AWS account ID of the AMI owner.

    • withImageOwnerAlias

      public Image withImageOwnerAlias(String imageOwnerAlias)

      The AWS account alias (for example, amazon, self) or the AWS account ID of the AMI owner.

      Parameters:
      imageOwnerAlias - The AWS account alias (for example, amazon, self) or the AWS account ID of the AMI owner.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setName

      public void setName(String name)

      The name of the AMI that was provided during image creation.

      Parameters:
      name - The name of the AMI that was provided during image creation.

    • getName

      public String getName()

      The name of the AMI that was provided during image creation.

      Returns:
      The name of the AMI that was provided during image creation.

    • withName

      public Image withName(String name)

      The name of the AMI that was provided during image creation.

      Parameters:
      name - The name of the AMI that was provided during image creation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setDescription

      public void setDescription(String description)

      The description of the AMI that was provided during image creation.

      Parameters:
      description - The description of the AMI that was provided during image creation.

    • getDescription

      public String getDescription()

      The description of the AMI that was provided during image creation.

      Returns:
      The description of the AMI that was provided during image creation.

    • withDescription

      public Image withDescription(String description)

      The description of the AMI that was provided during image creation.

      Parameters:
      description - The description of the AMI that was provided during image creation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setRootDeviceType

      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.

      Parameters:
      rootDeviceType - The type of root device used by the AMI. The AMI can use an EBS volume or an instance store volume.
      See Also:

    • getRootDeviceType

      public String getRootDeviceType()

      The type of root device used by the AMI. The AMI can use an EBS volume or an instance store volume.

      Returns:
      The type of root device used by the AMI. The AMI can use an EBS volume or an instance store volume.
      See Also:

    • withRootDeviceType

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

      Parameters:
      rootDeviceType - The type of root device used by the AMI. The AMI can use an EBS volume or an instance store volume.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • setRootDeviceType

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

      Parameters:
      rootDeviceType - The type of root device used by the AMI. The AMI can use an EBS volume or an instance store volume.
      See Also:

    • withRootDeviceType

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

      Parameters:
      rootDeviceType - The type of root device used by the AMI. The AMI can use an EBS volume or an instance store volume.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • setRootDeviceName

      public void setRootDeviceName(String rootDeviceName)

      The device name of the root device (for example, /dev/sda1 or /dev/xvda).

      Parameters:
      rootDeviceName - The device name of the root device (for example, /dev/sda1 or /dev/xvda).

    • getRootDeviceName

      public String getRootDeviceName()

      The device name of the root device (for example, /dev/sda1 or /dev/xvda).

      Returns:
      The device name of the root device (for example, /dev/sda1 or /dev/xvda).

    • withRootDeviceName

      public Image withRootDeviceName(String rootDeviceName)

      The device name of the root device (for example, /dev/sda1 or /dev/xvda).

      Parameters:
      rootDeviceName - The device name of the root device (for example, /dev/sda1 or /dev/xvda).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • getBlockDeviceMappings

      public List<BlockDeviceMapping> getBlockDeviceMappings()

      Any block device mapping entries.

      Returns:
      Any block device mapping entries.

    • setBlockDeviceMappings

      public void setBlockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)

      Any block device mapping entries.

      Parameters:
      blockDeviceMappings - Any block device mapping entries.

    • withBlockDeviceMappings

      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.

      Parameters:
      blockDeviceMappings - Any block device mapping entries.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • withBlockDeviceMappings

      public Image withBlockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)

      Any block device mapping entries.

      Parameters:
      blockDeviceMappings - Any block device mapping entries.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setVirtualizationType

      public void setVirtualizationType(String virtualizationType)

      The type of virtualization of the AMI.

      Parameters:
      virtualizationType - The type of virtualization of the AMI.
      See Also:

    • getVirtualizationType

      public String getVirtualizationType()

      The type of virtualization of the AMI.

      Returns:
      The type of virtualization of the AMI.
      See Also:

    • withVirtualizationType

      public Image withVirtualizationType(String virtualizationType)

      The type of virtualization of the AMI.

      Parameters:
      virtualizationType - The type of virtualization of the AMI.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • setVirtualizationType

      public void setVirtualizationType(VirtualizationType virtualizationType)

      The type of virtualization of the AMI.

      Parameters:
      virtualizationType - The type of virtualization of the AMI.
      See Also:

    • withVirtualizationType

      public Image withVirtualizationType(VirtualizationType virtualizationType)

      The type of virtualization of the AMI.

      Parameters:
      virtualizationType - The type of virtualization of the AMI.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • getTags

      public List<Tag> getTags()

      Any tags assigned to the image.

      Returns:
      Any tags assigned to the image.

    • setTags

      public void setTags(Collection<Tag> tags)

      Any tags assigned to the image.

      Parameters:
      tags - Any tags assigned to the image.

    • withTags

      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.

      Parameters:
      tags - Any tags assigned to the image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • withTags

      public Image withTags(Collection<Tag> tags)

      Any tags assigned to the image.

      Parameters:
      tags - Any tags assigned to the image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setHypervisor

      public void setHypervisor(String hypervisor)

      The hypervisor type of the image.

      Parameters:
      hypervisor - The hypervisor type of the image.
      See Also:

    • getHypervisor

      public String getHypervisor()

      The hypervisor type of the image.

      Returns:
      The hypervisor type of the image.
      See Also:

    • withHypervisor

      public Image withHypervisor(String hypervisor)

      The hypervisor type of the image.

      Parameters:
      hypervisor - The hypervisor type of the image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • setHypervisor

      public void setHypervisor(HypervisorType hypervisor)

      The hypervisor type of the image.

      Parameters:
      hypervisor - The hypervisor type of the image.
      See Also:

    • withHypervisor

      public Image withHypervisor(HypervisorType hypervisor)

      The hypervisor type of the image.

      Parameters:
      hypervisor - The hypervisor type of the image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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:

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • clone

      public Image clone()
      Overrides:
      clone in class Object