Class DescribeImageAttributeResponse
- java.lang.Object
-
- software.amazon.awssdk.core.SdkResponse
-
- software.amazon.awssdk.awscore.AwsResponse
-
- software.amazon.awssdk.services.ec2.model.Ec2Response
-
- software.amazon.awssdk.services.ec2.model.DescribeImageAttributeResponse
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeImageAttributeResponse.Builder,DescribeImageAttributeResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeImageAttributeResponse extends Ec2Response implements ToCopyableBuilder<DescribeImageAttributeResponse.Builder,DescribeImageAttributeResponse>
Describes an image attribute.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
DescribeImageAttributeResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<BlockDeviceMapping>
blockDeviceMappings()
The block device mapping entries.AttributeValue
bootMode()
The boot mode.static DescribeImageAttributeResponse.Builder
builder()
AttributeValue
description()
A description for the AMI.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
hasLaunchPermissions()
For responses, this returns true if the service returned a value for the LaunchPermissions property.boolean
hasProductCodes()
For responses, this returns true if the service returned a value for the ProductCodes property.String
imageId()
The ID of the AMI.AttributeValue
imdsSupport()
Ifv2.0
, it indicates that IMDSv2 is specified in the AMI.AttributeValue
kernelId()
The kernel ID.AttributeValue
lastLaunchedTime()
The date and time, in ISO 8601 date-time format, when the AMI was last used to launch an EC2 instance.List<LaunchPermission>
launchPermissions()
The launch permissions.List<ProductCode>
productCodes()
The product codes.AttributeValue
ramdiskId()
The RAM disk ID.List<SdkField<?>>
sdkFields()
static Class<? extends DescribeImageAttributeResponse.Builder>
serializableBuilderClass()
AttributeValue
sriovNetSupport()
Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.DescribeImageAttributeResponse.Builder
toBuilder()
String
toString()
Returns a string representation of this object.AttributeValue
tpmSupport()
If the image is configured for NitroTPM support, the value isv2.0
.AttributeValue
uefiData()
Base64 representation of the non-volatile UEFI variable store.-
Methods inherited from class software.amazon.awssdk.services.ec2.model.Ec2Response
responseMetadata
-
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
-
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
-
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()
The 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:
- The block device mapping entries.
-
imageId
public final String imageId()
The ID of the AMI.
- Returns:
- The ID of the AMI.
-
hasLaunchPermissions
public final boolean hasLaunchPermissions()
For responses, this returns true if the service returned a value for the LaunchPermissions 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.
-
launchPermissions
public final List<LaunchPermission> launchPermissions()
The launch permissions.
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
hasLaunchPermissions()
method.- Returns:
- The launch permissions.
-
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()
The product codes.
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:
- The product codes.
-
description
public final AttributeValue description()
A description for the AMI.
- Returns:
- A description for the AMI.
-
kernelId
public final AttributeValue kernelId()
The kernel ID.
- Returns:
- The kernel ID.
-
ramdiskId
public final AttributeValue ramdiskId()
The RAM disk ID.
- Returns:
- The RAM disk ID.
-
sriovNetSupport
public final AttributeValue sriovNetSupport()
Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
- Returns:
- Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
-
bootMode
public final AttributeValue bootMode()
The boot mode.
- Returns:
- The boot mode.
-
tpmSupport
public final AttributeValue tpmSupport()
If the image is configured for NitroTPM support, the value is
v2.0
.- Returns:
- If the image is configured for NitroTPM support, the value is
v2.0
.
-
uefiData
public final AttributeValue uefiData()
Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data, use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the python-uefivars tool on GitHub. For more information, see UEFI Secure Boot in the Amazon EC2 User Guide.
- Returns:
- Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data, use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the python-uefivars tool on GitHub. For more information, see UEFI Secure Boot in the Amazon EC2 User Guide.
-
lastLaunchedTime
public final AttributeValue 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.
-
imdsSupport
public final AttributeValue 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.- 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.
-
toBuilder
public DescribeImageAttributeResponse.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribeImageAttributeResponse.Builder,DescribeImageAttributeResponse>
- Specified by:
toBuilder
in classAwsResponse
-
builder
public static DescribeImageAttributeResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends DescribeImageAttributeResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsResponse
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkResponse
-
-