Package software.amazon.awssdk.services.ec2.model

Class DescribeInstanceAttributeResponse

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.DescribeInstanceAttributeResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeInstanceAttributeResponse.Builder,DescribeInstanceAttributeResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeInstanceAttributeResponse extends Ec2Response implements ToCopyableBuilder<DescribeInstanceAttributeResponse.Builder,DescribeInstanceAttributeResponse>

Describes an instance attribute.

  • Method Details

    • hasGroups

      public final boolean hasGroups()
      For responses, this returns true if the service returned a value for the Groups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

    • groups

      public final List<GroupIdentifier> groups()

      The security groups associated with the instance.

      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 hasGroups() method.

      Returns:
      The security groups associated with the instance.

    • 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 the isEmpty() 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<InstanceBlockDeviceMapping> blockDeviceMappings()

      The block device mapping of the instance.

      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 of the instance.

    • disableApiTermination

      public final AttributeBooleanValue disableApiTermination()

      If the value is true, you can't terminate the instance through the Amazon EC2 console, CLI, or API; otherwise, you can.

      Returns:
      If the value is true, you can't terminate the instance through the Amazon EC2 console, CLI, or API; otherwise, you can.

    • enaSupport

      public final AttributeBooleanValue enaSupport()

      Indicates whether enhanced networking with ENA is enabled.

      Returns:
      Indicates whether enhanced networking with ENA is enabled.

    • enclaveOptions

      public final EnclaveOptions enclaveOptions()

      To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to true; otherwise, set it to false.

      Returns:
      To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to true; otherwise, set it to false.

    • ebsOptimized

      public final AttributeBooleanValue ebsOptimized()

      Indicates whether the instance is optimized for Amazon EBS I/O.

      Returns:
      Indicates whether the instance is optimized for Amazon EBS I/O.

    • instanceId

      public final String instanceId()

      The ID of the instance.

      Returns:
      The ID of the instance.

    • instanceInitiatedShutdownBehavior

      public final AttributeValue instanceInitiatedShutdownBehavior()

      Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

      Returns:
      Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

    • instanceType

      public final AttributeValue instanceType()

      The instance type.

      Returns:
      The instance type.

    • kernelId

      public final AttributeValue kernelId()

      The kernel ID.

      Returns:
      The kernel ID.

    • 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 the isEmpty() 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()

      A list of 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:
      A list of product codes.

    • ramdiskId

      public final AttributeValue ramdiskId()

      The RAM disk ID.

      Returns:
      The RAM disk ID.

    • rootDeviceName

      public final AttributeValue 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).

    • sourceDestCheck

      public final AttributeBooleanValue sourceDestCheck()

      Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true, source/destination checks are enabled; otherwise, they are disabled. The default value is true. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.

      Returns:
      Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true, source/destination checks are enabled; otherwise, they are disabled. The default value is true. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.

    • 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.

    • userData

      public final AttributeValue userData()

      The user data.

      Returns:
      The user data.

    • disableApiStop

      public final AttributeBooleanValue disableApiStop()

      To enable the instance for Amazon Web Services Stop Protection, set this parameter to true; otherwise, set it to false.

      Returns:
      To enable the instance for Amazon Web Services Stop Protection, set this parameter to true; otherwise, set it to false.

    • toBuilder

      public DescribeInstanceAttributeResponse.Builder 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 interface ToCopyableBuilder<DescribeInstanceAttributeResponse.Builder,DescribeInstanceAttributeResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeInstanceAttributeResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeInstanceAttributeResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.