Class Image
- java.lang.Object
-
- software.amazon.awssdk.services.ec2.model.Image
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Image.Builder,Image>
@Generated("software.amazon.awssdk:codegen") public final class Image extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Image.Builder,Image>
Describes an image.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
Image.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ArchitectureValues
architecture()
The architecture of the image.String
architectureAsString()
The architecture of the image.List<BlockDeviceMapping>
blockDeviceMappings()
Any block device mapping entries.BootModeValues
bootMode()
The boot mode of the image.String
bootModeAsString()
The boot mode of the image.static Image.Builder
builder()
String
creationDate()
The date and time the image was created.String
deprecationTime()
The date and time to deprecate the AMI, in UTC, in the following format: YYYY-MM-DDTHH:MM:SSZ.String
description()
The description of the AMI that was provided during image creation.Boolean
enaSupport()
Specifies whether enhanced networking with ENA is enabled.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasBlockDeviceMappings()
For responses, this returns true if the service returned a value for the BlockDeviceMappings property.int
hashCode()
boolean
hasProductCodes()
For responses, this returns true if the service returned a value for the ProductCodes property.boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.HypervisorType
hypervisor()
The hypervisor type of the image.String
hypervisorAsString()
The hypervisor type of the image.String
imageId()
The ID of the AMI.String
imageLocation()
The location of the AMI.String
imageOwnerAlias()
The owner alias (amazon
|aws-marketplace
).ImageTypeValues
imageType()
The type of image.String
imageTypeAsString()
The type of image.ImdsSupportValues
imdsSupport()
Ifv2.0
, it indicates that IMDSv2 is specified in the AMI.String
imdsSupportAsString()
Ifv2.0
, it indicates that IMDSv2 is specified in the AMI.String
kernelId()
The kernel associated with the image, if any.String
name()
The name of the AMI that was provided during image creation.String
ownerId()
The ID of the Amazon Web Services account that owns the image.PlatformValues
platform()
This value is set towindows
for Windows AMIs; otherwise, it is blank.String
platformAsString()
This value is set towindows
for Windows AMIs; otherwise, it is blank.String
platformDetails()
The platform details associated with the billing code of the AMI.List<ProductCode>
productCodes()
Any product codes associated with the AMI.Boolean
publicLaunchPermissions()
Indicates whether the image has public launch permissions.String
ramdiskId()
The RAM disk associated with the image, if any.String
rootDeviceName()
The device name of the root device volume (for example,/dev/sda1
).DeviceType
rootDeviceType()
The type of root device used by the AMI.String
rootDeviceTypeAsString()
The type of root device used by the AMI.List<SdkField<?>>
sdkFields()
static Class<? extends Image.Builder>
serializableBuilderClass()
String
sourceInstanceId()
The ID of the instance that the AMI was created from if the AMI was created using CreateImage.String
sriovNetSupport()
Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.ImageState
state()
The current state of the AMI.String
stateAsString()
The current state of the AMI.StateReason
stateReason()
The reason for the state change.List<Tag>
tags()
Any tags assigned to the image.Image.Builder
toBuilder()
String
toString()
Returns a string representation of this object.TpmSupportValues
tpmSupport()
If the image is configured for NitroTPM support, the value isv2.0
.String
tpmSupportAsString()
If the image is configured for NitroTPM support, the value isv2.0
.String
usageOperation()
The operation of the Amazon EC2 instance and the billing code that is associated with the AMI.VirtualizationType
virtualizationType()
The type of virtualization of the AMI.String
virtualizationTypeAsString()
The type of virtualization of the AMI.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
architecture
public final ArchitectureValues 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:
ArchitectureValues
-
architectureAsString
public final String 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:
ArchitectureValues
-
creationDate
public final String creationDate()
The date and time the image was created.
- Returns:
- The date and time the image was created.
-
imageId
public final String imageId()
The ID of the AMI.
- Returns:
- The ID of the AMI.
-
imageLocation
public final String imageLocation()
The location of the AMI.
- Returns:
- The location of the AMI.
-
imageType
public final ImageTypeValues 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:
ImageTypeValues
-
imageTypeAsString
public final String 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:
ImageTypeValues
-
kernelId
public final String 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
public final String 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
public final PlatformValues 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:
PlatformValues
-
platformAsString
public final String 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:
PlatformValues
-
platformDetails
public final String 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
public final String 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
public final List<ProductCode> 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
public final String 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
public final 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.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:
ImageState
-
stateAsString
public final String 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:
ImageState
-
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
public final List<BlockDeviceMapping> 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
public final String 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
public final Boolean enaSupport()
Specifies whether enhanced networking with ENA is enabled.
- Returns:
- Specifies whether enhanced networking with ENA is enabled.
-
hypervisor
public final HypervisorType 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:
HypervisorType
-
hypervisorAsString
public final String 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:
HypervisorType
-
imageOwnerAlias
public final String imageOwnerAlias()
The owner alias (
amazon
|aws-marketplace
).- Returns:
- The owner alias (
amazon
|aws-marketplace
).
-
name
public final String 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
public final String 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
public final DeviceType 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:
DeviceType
-
rootDeviceTypeAsString
public final String 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:
DeviceType
-
sriovNetSupport
public final String 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
public final StateReason 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
public final List<Tag> 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
public final VirtualizationType 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:
VirtualizationType
-
virtualizationTypeAsString
public final String 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:
VirtualizationType
-
bootMode
public final BootModeValues 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:
BootModeValues
-
bootModeAsString
public final String 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:
BootModeValues
-
tpmSupport
public final TpmSupportValues 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:
TpmSupportValues
-
tpmSupportAsString
public final String 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:
TpmSupportValues
-
deprecationTime
public final String 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
public final ImdsSupportValues 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:
ImdsSupportValues
-
imdsSupportAsString
public final String 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:
ImdsSupportValues
-
sourceInstanceId
public final String 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.
-
publicLaunchPermissions
public final Boolean 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
public Image.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<Image.Builder,Image>
-
builder
public static Image.Builder builder()
-
serializableBuilderClass
public static Class<? extends Image.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String 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.
-
-