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

Class InstanceMetadataOptionsResponse

java.lang.Object
software.amazon.awssdk.services.ec2.model.InstanceMetadataOptionsResponse
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<InstanceMetadataOptionsResponse.Builder,InstanceMetadataOptionsResponse>
@Generated("software.amazon.awssdk:codegen") public final class InstanceMetadataOptionsResponse extends Object implements SdkPojo, Serializable, ToCopyableBuilder<InstanceMetadataOptionsResponse.Builder,InstanceMetadataOptionsResponse>

The metadata options for the instance.

See Also:

  • Method Details

    • state

      public final InstanceMetadataOptionsState state()

      The state of the metadata option changes.

      pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.

      applied - The metadata options have been successfully applied on the instance.

      If the service returns an enum value that is not available in the current SDK version, state will return InstanceMetadataOptionsState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The state of the metadata option changes.

      pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.

      applied - The metadata options have been successfully applied on the instance.

      See Also:

    • stateAsString

      public final String stateAsString()

      The state of the metadata option changes.

      pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.

      applied - The metadata options have been successfully applied on the instance.

      If the service returns an enum value that is not available in the current SDK version, state will return InstanceMetadataOptionsState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The state of the metadata option changes.

      pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.

      applied - The metadata options have been successfully applied on the instance.

      See Also:

    • httpTokens

      public final HttpTokensState httpTokens()

      Indicates whether IMDSv2 is required.

      • optional - IMDSv2 is optional, which means that you can use either IMDSv2 or IMDSv1.

      • required - IMDSv2 is required, which means that IMDSv1 is disabled, and you must use IMDSv2.

      If the service returns an enum value that is not available in the current SDK version, httpTokens will return HttpTokensState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from httpTokensAsString().

      Returns:
      Indicates whether IMDSv2 is required.

      • optional - IMDSv2 is optional, which means that you can use either IMDSv2 or IMDSv1.

      • required - IMDSv2 is required, which means that IMDSv1 is disabled, and you must use IMDSv2.

      See Also:

    • httpTokensAsString

      public final String httpTokensAsString()

      Indicates whether IMDSv2 is required.

      • optional - IMDSv2 is optional, which means that you can use either IMDSv2 or IMDSv1.

      • required - IMDSv2 is required, which means that IMDSv1 is disabled, and you must use IMDSv2.

      If the service returns an enum value that is not available in the current SDK version, httpTokens will return HttpTokensState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from httpTokensAsString().

      Returns:
      Indicates whether IMDSv2 is required.

      • optional - IMDSv2 is optional, which means that you can use either IMDSv2 or IMDSv1.

      • required - IMDSv2 is required, which means that IMDSv1 is disabled, and you must use IMDSv2.

      See Also:

    • httpPutResponseHopLimit

      public final Integer httpPutResponseHopLimit()

      The maximum number of hops that the metadata token can travel.

      Possible values: Integers from 1 to 64

      Returns:
      The maximum number of hops that the metadata token can travel.

      Possible values: Integers from 1 to 64

    • httpEndpoint

      public final InstanceMetadataEndpointState httpEndpoint()

      Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.

      If the value is disabled, you cannot access your instance metadata.

      If the service returns an enum value that is not available in the current SDK version, httpEndpoint will return InstanceMetadataEndpointState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from httpEndpointAsString().

      Returns:
      Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.

      If the value is disabled, you cannot access your instance metadata.

      See Also:

    • httpEndpointAsString

      public final String httpEndpointAsString()

      Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.

      If the value is disabled, you cannot access your instance metadata.

      If the service returns an enum value that is not available in the current SDK version, httpEndpoint will return InstanceMetadataEndpointState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from httpEndpointAsString().

      Returns:
      Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.

      If the value is disabled, you cannot access your instance metadata.

      See Also:

    • httpProtocolIpv6

      public final InstanceMetadataProtocolState httpProtocolIpv6()

      Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.

      Default: disabled

      If the service returns an enum value that is not available in the current SDK version, httpProtocolIpv6 will return InstanceMetadataProtocolState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from httpProtocolIpv6AsString().

      Returns:
      Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.

      Default: disabled

      See Also:

    • httpProtocolIpv6AsString

      public final String httpProtocolIpv6AsString()

      Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.

      Default: disabled

      If the service returns an enum value that is not available in the current SDK version, httpProtocolIpv6 will return InstanceMetadataProtocolState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from httpProtocolIpv6AsString().

      Returns:
      Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.

      Default: disabled

      See Also:

    • instanceMetadataTags

      public final InstanceMetadataTagsState instanceMetadataTags()

      Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see Work with instance tags using the instance metadata.

      If the service returns an enum value that is not available in the current SDK version, instanceMetadataTags will return InstanceMetadataTagsState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceMetadataTagsAsString().

      Returns:
      Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see Work with instance tags using the instance metadata.
      See Also:

    • instanceMetadataTagsAsString

      public final String instanceMetadataTagsAsString()

      Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see Work with instance tags using the instance metadata.

      If the service returns an enum value that is not available in the current SDK version, instanceMetadataTags will return InstanceMetadataTagsState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceMetadataTagsAsString().

      Returns:
      Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see Work with instance tags using the instance metadata.
      See Also:

    • toBuilder

      public InstanceMetadataOptionsResponse.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<InstanceMetadataOptionsResponse.Builder,InstanceMetadataOptionsResponse>
      Returns:
      a builder for type T

    • builder

      public static InstanceMetadataOptionsResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

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