Class Image
- All Implemented Interfaces:
Serializable
,Cloneable
Describes an image.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
The architecture of the image.Any block device mapping entries.The date and time the image was created.The description of the AMI that was provided during image creation.The hypervisor type of the image.The ID of the AMI.The location of the AMI.The AWS account alias (for example,amazon
,self
) or the AWS account ID of the AMI owner.The type of image.The kernel associated with the image, if any.getName()
The name of the AMI that was provided during image creation.The AWS account ID of the image owner.The value isWindows
for Windows AMIs; otherwise blank.Any product codes associated with the AMI.Indicates whether the image has public launch permissions.The RAM disk associated with the image, if any.The device name of the root device (for example,/dev/sda1
or/dev/xvda
).The type of root device used by the AMI.Specifies whether enhanced networking is enabled.getState()
The current state of the AMI.The reason for the state change.getTags()
Any tags assigned to the image.The type of virtualization of the AMI.int
hashCode()
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
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
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 isWindows
for Windows AMIs; otherwise blank.void
setPlatform
(String platform) The value isWindows
for Windows AMIs; otherwise blank.void
setProductCodes
(Collection<ProductCode> productCodes) Any product codes associated with the AMI.void
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 is enabled.void
setState
(ImageState state) The current state of the AMI.void
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
(VirtualizationType virtualizationType) The type of virtualization of the AMI.void
setVirtualizationType
(String virtualizationType) The type of virtualization of the AMI.toString()
Returns a string representation of this object; useful for testing and debugging.withArchitecture
(ArchitectureValues architecture) The architecture of the image.withArchitecture
(String architecture) The architecture of the image.withBlockDeviceMappings
(BlockDeviceMapping... blockDeviceMappings) Any block device mapping entries.withBlockDeviceMappings
(Collection<BlockDeviceMapping> blockDeviceMappings) Any block device mapping entries.withCreationDate
(String creationDate) The date and time the image was created.withDescription
(String description) The description of the AMI that was provided during image creation.withHypervisor
(HypervisorType hypervisor) The hypervisor type of the image.withHypervisor
(String hypervisor) The hypervisor type of the image.withImageId
(String imageId) The ID of the AMI.withImageLocation
(String imageLocation) The location of the AMI.withImageOwnerAlias
(String imageOwnerAlias) The AWS account alias (for example,amazon
,self
) or the AWS account ID of the AMI owner.withImageType
(ImageTypeValues imageType) The type of image.withImageType
(String imageType) The type of image.withKernelId
(String kernelId) The kernel associated with the image, if any.The name of the AMI that was provided during image creation.withOwnerId
(String ownerId) The AWS account ID of the image owner.withPlatform
(PlatformValues platform) The value isWindows
for Windows AMIs; otherwise blank.withPlatform
(String platform) The value isWindows
for Windows AMIs; otherwise blank.withProductCodes
(ProductCode... productCodes) Any product codes associated with the AMI.withProductCodes
(Collection<ProductCode> productCodes) Any product codes associated with the AMI.withPublic
(Boolean publicValue) Indicates whether the image has public launch permissions.withRamdiskId
(String ramdiskId) The RAM disk associated with the image, if any.withRootDeviceName
(String rootDeviceName) The device name of the root device (for example,/dev/sda1
or/dev/xvda
).withRootDeviceType
(DeviceType rootDeviceType) The type of root device used by the AMI.withRootDeviceType
(String rootDeviceType) The type of root device used by the AMI.withSriovNetSupport
(String sriovNetSupport) Specifies whether enhanced networking is enabled.withState
(ImageState state) The current state of the AMI.The current state of the AMI.withStateReason
(StateReason stateReason) The reason for the state change.Any tags assigned to the image.withTags
(Collection<Tag> tags) Any tags assigned to the image.withVirtualizationType
(VirtualizationType virtualizationType) The type of virtualization of the AMI.withVirtualizationType
(String virtualizationType) The type of virtualization of the AMI.
-
Constructor Details
-
Image
public Image()
-
-
Method Details
-
setImageId
The ID of the AMI.
- Parameters:
imageId
- The ID of the AMI.
-
getImageId
The ID of the AMI.
- Returns:
- The ID of the AMI.
-
withImageId
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
The location of the AMI.
- Parameters:
imageLocation
- The location of the AMI.
-
getImageLocation
The location of the AMI.
- Returns:
- The location of the AMI.
-
withImageLocation
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
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 isavailable
, the image is successfully registered and can be used to launch an instance.- See Also:
-
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
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 isavailable
, 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
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 isavailable
, the image is successfully registered and can be used to launch an instance.- See Also:
-
withState
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 isavailable
, 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
The AWS account ID of the image owner.
- Parameters:
ownerId
- The AWS account ID of the image owner.
-
getOwnerId
The AWS account ID of the image owner.
- Returns:
- The AWS account ID of the image owner.
-
withOwnerId
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
The date and time the image was created.
- Parameters:
creationDate
- The date and time the image was created.
-
getCreationDate
The date and time the image was created.
- Returns:
- The date and time the image was created.
-
withCreationDate
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
Indicates whether the image has public launch permissions. The value is
true
if this image has public launch permissions orfalse
if it has only implicit and explicit launch permissions.- Parameters:
publicValue
- Indicates whether the image has public launch permissions. The value istrue
if this image has public launch permissions orfalse
if it has only implicit and explicit launch permissions.
-
getPublic
Indicates whether the image has public launch permissions. The value is
true
if this image has public launch permissions orfalse
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 orfalse
if it has only implicit and explicit launch permissions.
-
withPublic
Indicates whether the image has public launch permissions. The value is
true
if this image has public launch permissions orfalse
if it has only implicit and explicit launch permissions.- Parameters:
publicValue
- Indicates whether the image has public launch permissions. The value istrue
if this image has public launch permissions orfalse
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
Indicates whether the image has public launch permissions. The value is
true
if this image has public launch permissions orfalse
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 orfalse
if it has only implicit and explicit launch permissions.
-
getProductCodes
Any product codes associated with the AMI.
- Returns:
- Any product codes associated with the AMI.
-
setProductCodes
Any product codes associated with the AMI.
- Parameters:
productCodes
- Any product codes associated with the AMI.
-
withProductCodes
Any product codes associated with the AMI.
NOTE: This method appends the values to the existing list (if any). Use
setProductCodes(java.util.Collection)
orwithProductCodes(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
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
The architecture of the image.
- Parameters:
architecture
- The architecture of the image.- See Also:
-
getArchitecture
The architecture of the image.
- Returns:
- The architecture of the image.
- See Also:
-
withArchitecture
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
The architecture of the image.
- Parameters:
architecture
- The architecture of the image.- See Also:
-
withArchitecture
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
The type of image.
- Parameters:
imageType
- The type of image.- See Also:
-
getImageType
The type of image.
- Returns:
- The type of image.
- See Also:
-
withImageType
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
The type of image.
- Parameters:
imageType
- The type of image.- See Also:
-
withImageType
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
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
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
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
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
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
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
The value is
Windows
for Windows AMIs; otherwise blank.- Parameters:
platform
- The value isWindows
for Windows AMIs; otherwise blank.- See Also:
-
getPlatform
The value is
Windows
for Windows AMIs; otherwise blank.- Returns:
- The value is
Windows
for Windows AMIs; otherwise blank. - See Also:
-
withPlatform
The value is
Windows
for Windows AMIs; otherwise blank.- Parameters:
platform
- The value isWindows
for Windows AMIs; otherwise blank.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setPlatform
The value is
Windows
for Windows AMIs; otherwise blank.- Parameters:
platform
- The value isWindows
for Windows AMIs; otherwise blank.- See Also:
-
withPlatform
The value is
Windows
for Windows AMIs; otherwise blank.- Parameters:
platform
- The value isWindows
for Windows AMIs; otherwise blank.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setSriovNetSupport
Specifies whether enhanced networking is enabled.
- Parameters:
sriovNetSupport
- Specifies whether enhanced networking is enabled.
-
getSriovNetSupport
Specifies whether enhanced networking is enabled.
- Returns:
- Specifies whether enhanced networking is enabled.
-
withSriovNetSupport
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
The reason for the state change.
- Parameters:
stateReason
- The reason for the state change.
-
getStateReason
The reason for the state change.
- Returns:
- The reason for the state change.
-
withStateReason
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
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
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
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
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
The name of the AMI that was provided during image creation.
- Returns:
- The name of the AMI that was provided during image creation.
-
withName
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
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
The description of the AMI that was provided during image creation.
- Returns:
- The description of the AMI that was provided during image creation.
-
withDescription
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
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
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
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
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
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
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
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
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
Any block device mapping entries.
- Returns:
- Any block device mapping entries.
-
setBlockDeviceMappings
Any block device mapping entries.
- Parameters:
blockDeviceMappings
- Any block device mapping entries.
-
withBlockDeviceMappings
Any block device mapping entries.
NOTE: This method appends the values to the existing list (if any). Use
setBlockDeviceMappings(java.util.Collection)
orwithBlockDeviceMappings(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
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
The type of virtualization of the AMI.
- Parameters:
virtualizationType
- The type of virtualization of the AMI.- See Also:
-
getVirtualizationType
The type of virtualization of the AMI.
- Returns:
- The type of virtualization of the AMI.
- See Also:
-
withVirtualizationType
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
The type of virtualization of the AMI.
- Parameters:
virtualizationType
- The type of virtualization of the AMI.- See Also:
-
withVirtualizationType
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
Any tags assigned to the image.
- Returns:
- Any tags assigned to the image.
-
setTags
Any tags assigned to the image.
- Parameters:
tags
- Any tags assigned to the image.
-
withTags
Any tags assigned to the image.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
orwithTags(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
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
The hypervisor type of the image.
- Parameters:
hypervisor
- The hypervisor type of the image.- See Also:
-
getHypervisor
The hypervisor type of the image.
- Returns:
- The hypervisor type of the image.
- See Also:
-
withHypervisor
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
The hypervisor type of the image.
- Parameters:
hypervisor
- The hypervisor type of the image.- See Also:
-
withHypervisor
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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-