@Generated(value="software.amazon.awssdk:codegen") public final class Image extends Object implements ToCopyableBuilder<Image.Builder,Image>
Describes an image.
Modifier and Type | Class and Description |
---|---|
static interface |
Image.Builder |
Modifier and Type | Method and Description |
---|---|
ArchitectureValues |
architecture()
The architecture of the image.
|
String |
architectureAsString()
The architecture of the image.
|
List<BlockDeviceMapping> |
blockDeviceMappings()
Any block device mapping entries.
|
static Image.Builder |
builder() |
String |
creationDate()
The date and time the image was created.
|
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) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
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 AWS account alias (for example,
amazon , self ) or the AWS account ID of the AMI
owner. |
ImageTypeValues |
imageType()
The type of image.
|
String |
imageTypeAsString()
The type of image.
|
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 AWS account ID of the image owner.
|
PlatformValues |
platform()
The value is
Windows for Windows AMIs; otherwise blank. |
String |
platformAsString()
The value is
Windows for Windows AMIs; otherwise blank. |
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.
|
static Class<? extends Image.Builder> |
serializableBuilderClass() |
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()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
VirtualizationType |
virtualizationType()
The type of virtualization of the AMI.
|
String |
virtualizationTypeAsString()
The type of virtualization of the AMI.
|
copy
public 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
return ArchitectureValues.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
architectureAsString()
.
ArchitectureValues
public 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
return ArchitectureValues.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
architectureAsString()
.
ArchitectureValues
public String creationDate()
The date and time the image was created.
public String imageId()
The ID of the AMI.
public String imageLocation()
The location of the AMI.
public ImageTypeValues imageType()
The type of image.
If the service returns an enum value that is not available in the current SDK version, imageType
will
return ImageTypeValues.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
imageTypeAsString()
.
ImageTypeValues
public String imageTypeAsString()
The type of image.
If the service returns an enum value that is not available in the current SDK version, imageType
will
return ImageTypeValues.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
imageTypeAsString()
.
ImageTypeValues
public String kernelId()
The kernel associated with the image, if any. Only applicable for machine images.
public String ownerId()
The AWS account ID of the image owner.
public PlatformValues platform()
The value is Windows
for Windows AMIs; otherwise blank.
If the service returns an enum value that is not available in the current SDK version, platform
will
return PlatformValues.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
platformAsString()
.
Windows
for Windows AMIs; otherwise blank.PlatformValues
public String platformAsString()
The value is Windows
for Windows AMIs; otherwise blank.
If the service returns an enum value that is not available in the current SDK version, platform
will
return PlatformValues.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
platformAsString()
.
Windows
for Windows AMIs; otherwise blank.PlatformValues
public List<ProductCode> productCodes()
Any product codes associated with the AMI.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public String ramdiskId()
The RAM disk associated with the image, if any. Only applicable for machine images.
public 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 return
ImageState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
stateAsString()
.
available
, the image is successfully
registered and can be used to launch an instance.ImageState
public 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 return
ImageState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
stateAsString()
.
available
, the image is successfully
registered and can be used to launch an instance.ImageState
public List<BlockDeviceMapping> blockDeviceMappings()
Any block device mapping entries.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public String description()
The description of the AMI that was provided during image creation.
public Boolean enaSupport()
Specifies whether enhanced networking with ENA is enabled.
public HypervisorType hypervisor()
The hypervisor type of the image.
If the service returns an enum value that is not available in the current SDK version, hypervisor
will
return HypervisorType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
hypervisorAsString()
.
HypervisorType
public String hypervisorAsString()
The hypervisor type of the image.
If the service returns an enum value that is not available in the current SDK version, hypervisor
will
return HypervisorType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
hypervisorAsString()
.
HypervisorType
public String imageOwnerAlias()
The AWS account alias (for example, amazon
, self
) or the AWS account ID of the AMI
owner.
amazon
, self
) or the AWS account ID of the
AMI owner.public String name()
The name of the AMI that was provided during image creation.
public String rootDeviceName()
The device name of the root device volume (for example, /dev/sda1
).
/dev/sda1
).public DeviceType rootDeviceType()
The type of root device used by the AMI. The AMI can use an 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 return DeviceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
rootDeviceTypeAsString()
.
DeviceType
public String rootDeviceTypeAsString()
The type of root device used by the AMI. The AMI can use an 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 return DeviceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
rootDeviceTypeAsString()
.
DeviceType
public String sriovNetSupport()
Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
public StateReason stateReason()
The reason for the state change.
public List<Tag> tags()
Any tags assigned to the image.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public 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 return VirtualizationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned
by the service is available from virtualizationTypeAsString()
.
VirtualizationType
public 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 return VirtualizationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned
by the service is available from virtualizationTypeAsString()
.
VirtualizationType
public Boolean publicLaunchPermissions()
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.
true
if this image
has public launch permissions or false
if it has only implicit and explicit launch
permissions.public Image.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<Image.Builder,Image>
public static Image.Builder builder()
public static Class<? extends Image.Builder> serializableBuilderClass()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.