Class Image
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Image.Builder,
Image>
Describes an image.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal ArchitectureValues
The architecture of the image.final String
The architecture of the image.final List
<BlockDeviceMapping> Any block device mapping entries.final BootModeValues
bootMode()
The boot mode of the image.final String
The boot mode of the image.static Image.Builder
builder()
final String
The date and time the image was created.final String
The date and time to deprecate the AMI, in UTC, in the following format: YYYY-MM-DDTHH:MM:SSZ.final String
Indicates whether deregistration protection is enabled for the AMI.final String
The description of the AMI that was provided during image creation.final Boolean
Specifies whether enhanced networking with ENA is enabled.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the BlockDeviceMappings property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ProductCodes property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final HypervisorType
The hypervisor type of the image.final String
The hypervisor type of the image.final String
imageId()
The ID of the AMI.final String
The location of the AMI.final String
The owner alias (amazon
|aws-marketplace
).final ImageTypeValues
The type of image.final String
The type of image.final ImdsSupportValues
Ifv2.0
, it indicates that IMDSv2 is specified in the AMI.final String
Ifv2.0
, it indicates that IMDSv2 is specified in the AMI.final String
kernelId()
The kernel associated with the image, if any.final String
The date and time, in ISO 8601 date-time format, when the AMI was last used to launch an EC2 instance.final String
name()
The name of the AMI that was provided during image creation.final String
ownerId()
The ID of the Amazon Web Services account that owns the image.final PlatformValues
platform()
This value is set towindows
for Windows AMIs; otherwise, it is blank.final String
This value is set towindows
for Windows AMIs; otherwise, it is blank.final String
The platform details associated with the billing code of the AMI.final List
<ProductCode> Any product codes associated with the AMI.final Boolean
Indicates whether the image has public launch permissions.final String
The RAM disk associated with the image, if any.final String
The device name of the root device volume (for example,/dev/sda1
).final DeviceType
The type of root device used by the AMI.final String
The type of root device used by the AMI.static Class
<? extends Image.Builder> final String
The ID of the instance that the AMI was created from if the AMI was created using CreateImage.final String
Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.final ImageState
state()
The current state of the AMI.final String
The current state of the AMI.final StateReason
The reason for the state change.tags()
Any tags assigned to the image.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final TpmSupportValues
If the image is configured for NitroTPM support, the value isv2.0
.final String
If the image is configured for NitroTPM support, the value isv2.0
.final String
The operation of the Amazon EC2 instance and the billing code that is associated with the AMI.final VirtualizationType
The type of virtualization of the AMI.final String
The type of virtualization of the AMI.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
architecture
The architecture of the image.
If the service returns an enum value that is not available in the current SDK version,
architecture
will returnArchitectureValues.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromarchitectureAsString()
.- Returns:
- The architecture of the image.
- See Also:
-
architectureAsString
The architecture of the image.
If the service returns an enum value that is not available in the current SDK version,
architecture
will returnArchitectureValues.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromarchitectureAsString()
.- Returns:
- The architecture of the image.
- See Also:
-
creationDate
The date and time the image was created.
- Returns:
- The date and time the image was created.
-
imageId
The ID of the AMI.
- Returns:
- The ID of the AMI.
-
imageLocation
The location of the AMI.
- Returns:
- The location of the AMI.
-
imageType
The type of image.
If the service returns an enum value that is not available in the current SDK version,
imageType
will returnImageTypeValues.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromimageTypeAsString()
.- Returns:
- The type of image.
- See Also:
-
imageTypeAsString
The type of image.
If the service returns an enum value that is not available in the current SDK version,
imageType
will returnImageTypeValues.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromimageTypeAsString()
.- Returns:
- The type of image.
- See Also:
-
kernelId
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.
-
ownerId
The ID of the Amazon Web Services account that owns the image.
- Returns:
- The ID of the Amazon Web Services account that owns the image.
-
platform
This value is set to
windows
for Windows AMIs; otherwise, it is blank.If the service returns an enum value that is not available in the current SDK version,
platform
will returnPlatformValues.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromplatformAsString()
.- Returns:
- This value is set to
windows
for Windows AMIs; otherwise, it is blank. - See Also:
-
platformAsString
This value is set to
windows
for Windows AMIs; otherwise, it is blank.If the service returns an enum value that is not available in the current SDK version,
platform
will returnPlatformValues.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromplatformAsString()
.- Returns:
- This value is set to
windows
for Windows AMIs; otherwise, it is blank. - See Also:
-
platformDetails
The platform details associated with the billing code of the AMI. For more information, see Understand AMI billing information in the Amazon EC2 User Guide.
- Returns:
- The platform details associated with the billing code of the AMI. For more information, see Understand AMI billing information in the Amazon EC2 User Guide.
-
usageOperation
The operation of the Amazon EC2 instance and the billing code that is associated with the AMI.
usageOperation
corresponds to the lineitem/Operation column on your Amazon Web Services Cost and Usage Report and in the Amazon Web Services Price List API. You can view these fields on the Instances or AMIs pages in the Amazon EC2 console, or in the responses that are returned by the DescribeImages command in the Amazon EC2 API, or the describe-images command in the CLI.- Returns:
- The operation of the Amazon EC2 instance and the billing code that is associated with the AMI.
usageOperation
corresponds to the lineitem/Operation column on your Amazon Web Services Cost and Usage Report and in the Amazon Web Services Price List API. You can view these fields on the Instances or AMIs pages in the Amazon EC2 console, or in the responses that are returned by the DescribeImages command in the Amazon EC2 API, or the describe-images command in the CLI.
-
hasProductCodes
public final boolean hasProductCodes()For responses, this returns true if the service returned a value for the ProductCodes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
productCodes
Any product codes associated with the AMI.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasProductCodes()
method.- Returns:
- Any product codes associated with the AMI.
-
ramdiskId
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.
-
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.If the service returns an enum value that is not available in the current SDK version,
state
will returnImageState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- 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:
-
stateAsString
The current state of the AMI. If the state is
available
, the image is successfully registered and can be used to launch an instance.If the service returns an enum value that is not available in the current SDK version,
state
will returnImageState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- 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:
-
hasBlockDeviceMappings
public final boolean hasBlockDeviceMappings()For responses, this returns true if the service returned a value for the BlockDeviceMappings property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
blockDeviceMappings
Any block device mapping entries.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasBlockDeviceMappings()
method.- Returns:
- Any block device mapping entries.
-
description
The description of the AMI that was provided during image creation.
- Returns:
- The description of the AMI that was provided during image creation.
-
enaSupport
Specifies whether enhanced networking with ENA is enabled.
- Returns:
- Specifies whether enhanced networking with ENA is enabled.
-
hypervisor
The hypervisor type of the image. Only
xen
is supported.ovm
is not supported.If the service returns an enum value that is not available in the current SDK version,
hypervisor
will returnHypervisorType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhypervisorAsString()
.- Returns:
- The hypervisor type of the image. Only
xen
is supported.ovm
is not supported. - See Also:
-
hypervisorAsString
The hypervisor type of the image. Only
xen
is supported.ovm
is not supported.If the service returns an enum value that is not available in the current SDK version,
hypervisor
will returnHypervisorType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhypervisorAsString()
.- Returns:
- The hypervisor type of the image. Only
xen
is supported.ovm
is not supported. - See Also:
-
imageOwnerAlias
The owner alias (
amazon
|aws-marketplace
).- Returns:
- The owner alias (
amazon
|aws-marketplace
).
-
name
The name of the AMI that was provided during image creation.
- Returns:
- The name of the AMI that was provided during image creation.
-
rootDeviceName
The device name of the root device volume (for example,
/dev/sda1
).- Returns:
- The device name of the root device volume (for example,
/dev/sda1
).
-
rootDeviceType
The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.
If the service returns an enum value that is not available in the current SDK version,
rootDeviceType
will returnDeviceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrootDeviceTypeAsString()
.- Returns:
- The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.
- See Also:
-
rootDeviceTypeAsString
The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.
If the service returns an enum value that is not available in the current SDK version,
rootDeviceType
will returnDeviceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrootDeviceTypeAsString()
.- Returns:
- The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.
- See Also:
-
sriovNetSupport
Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
- Returns:
- Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
-
stateReason
The reason for the state change.
- Returns:
- The reason for the state change.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
tags
Any tags assigned to the image.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- Returns:
- Any tags assigned to the image.
-
virtualizationType
The type of virtualization of the AMI.
If the service returns an enum value that is not available in the current SDK version,
virtualizationType
will returnVirtualizationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvirtualizationTypeAsString()
.- Returns:
- The type of virtualization of the AMI.
- See Also:
-
virtualizationTypeAsString
The type of virtualization of the AMI.
If the service returns an enum value that is not available in the current SDK version,
virtualizationType
will returnVirtualizationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvirtualizationTypeAsString()
.- Returns:
- The type of virtualization of the AMI.
- See Also:
-
bootMode
The boot mode of the image. For more information, see Boot modes in the Amazon EC2 User Guide.
If the service returns an enum value that is not available in the current SDK version,
bootMode
will returnBootModeValues.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frombootModeAsString()
.- Returns:
- The boot mode of the image. For more information, see Boot modes in the Amazon EC2 User Guide.
- See Also:
-
bootModeAsString
The boot mode of the image. For more information, see Boot modes in the Amazon EC2 User Guide.
If the service returns an enum value that is not available in the current SDK version,
bootMode
will returnBootModeValues.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frombootModeAsString()
.- Returns:
- The boot mode of the image. For more information, see Boot modes in the Amazon EC2 User Guide.
- See Also:
-
tpmSupport
If the image is configured for NitroTPM support, the value is
v2.0
. For more information, see NitroTPM in the Amazon EC2 User Guide.If the service returns an enum value that is not available in the current SDK version,
tpmSupport
will returnTpmSupportValues.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtpmSupportAsString()
.- Returns:
- If the image is configured for NitroTPM support, the value is
v2.0
. For more information, see NitroTPM in the Amazon EC2 User Guide. - See Also:
-
tpmSupportAsString
If the image is configured for NitroTPM support, the value is
v2.0
. For more information, see NitroTPM in the Amazon EC2 User Guide.If the service returns an enum value that is not available in the current SDK version,
tpmSupport
will returnTpmSupportValues.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtpmSupportAsString()
.- Returns:
- If the image is configured for NitroTPM support, the value is
v2.0
. For more information, see NitroTPM in the Amazon EC2 User Guide. - See Also:
-
deprecationTime
The date and time to deprecate the AMI, in UTC, in the following format: YYYY-MM-DDTHH:MM:SSZ. If you specified a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.
- Returns:
- The date and time to deprecate the AMI, in UTC, in the following format: YYYY-MM-DDTHH:MM:SSZ. If you specified a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.
-
imdsSupport
If
v2.0
, it indicates that IMDSv2 is specified in the AMI. Instances launched from this AMI will haveHttpTokens
automatically set torequired
so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition,HttpPutResponseHopLimit
is set to2
. For more information, see Configure the AMI in the Amazon EC2 User Guide.If the service returns an enum value that is not available in the current SDK version,
imdsSupport
will returnImdsSupportValues.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromimdsSupportAsString()
.- Returns:
- If
v2.0
, it indicates that IMDSv2 is specified in the AMI. Instances launched from this AMI will haveHttpTokens
automatically set torequired
so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition,HttpPutResponseHopLimit
is set to2
. For more information, see Configure the AMI in the Amazon EC2 User Guide. - See Also:
-
imdsSupportAsString
If
v2.0
, it indicates that IMDSv2 is specified in the AMI. Instances launched from this AMI will haveHttpTokens
automatically set torequired
so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition,HttpPutResponseHopLimit
is set to2
. For more information, see Configure the AMI in the Amazon EC2 User Guide.If the service returns an enum value that is not available in the current SDK version,
imdsSupport
will returnImdsSupportValues.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromimdsSupportAsString()
.- Returns:
- If
v2.0
, it indicates that IMDSv2 is specified in the AMI. Instances launched from this AMI will haveHttpTokens
automatically set torequired
so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition,HttpPutResponseHopLimit
is set to2
. For more information, see Configure the AMI in the Amazon EC2 User Guide. - See Also:
-
sourceInstanceId
The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This field only appears if the AMI was created using CreateImage.
- Returns:
- The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This field only appears if the AMI was created using CreateImage.
-
deregistrationProtection
Indicates whether deregistration protection is enabled for the AMI.
- Returns:
- Indicates whether deregistration protection is enabled for the AMI.
-
lastLaunchedTime
The date and time, in ISO 8601 date-time format, when the AMI was last used to launch an EC2 instance. When the AMI is used to launch an instance, there is a 24-hour delay before that usage is reported.
lastLaunchedTime
data is available starting April 2017.- Returns:
- The date and time, in ISO 8601 date-time format, when the
AMI was last used to launch an EC2 instance. When the AMI is used to launch an instance, there is a
24-hour delay before that usage is reported.
lastLaunchedTime
data is available starting April 2017.
-
publicLaunchPermissions
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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Image.Builder,
Image> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-