Class InstanceMetadataOptionsRequest

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

The metadata options for the instance.

See Also:

  • Method Details

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

      Default:

      • If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0 and the account level default is set to no-preference, the default is required.

      • If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0, but the account level default is set to V1 or V2, the default is optional.

      The default value can also be affected by other combinations of parameters. For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.

      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.

      Default:

      • If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0 and the account level default is set to no-preference, the default is required.

      • If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0, but the account level default is set to V1 or V2, the default is optional.

      The default value can also be affected by other combinations of parameters. For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.

      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.

      Default:

      • If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0 and the account level default is set to no-preference, the default is required.

      • If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0, but the account level default is set to V1 or V2, the default is optional.

      The default value can also be affected by other combinations of parameters. For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.

      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.

      Default:

      • If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0 and the account level default is set to no-preference, the default is required.

      • If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0, but the account level default is set to V1 or V2, the default is optional.

      The default value can also be affected by other combinations of parameters. For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.

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

      Enables or disables the HTTP metadata endpoint on your instances.

      If you specify a value of disabled, you cannot access your instance metadata.

      Default: enabled

      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:
      Enables or disables the HTTP metadata endpoint on your instances.

      If you specify a value of disabled, you cannot access your instance metadata.

      Default: enabled

      See Also:

    • httpEndpointAsString

      public final String httpEndpointAsString()

      Enables or disables the HTTP metadata endpoint on your instances.

      If you specify a value of disabled, you cannot access your instance metadata.

      Default: enabled

      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:
      Enables or disables the HTTP metadata endpoint on your instances.

      If you specify a value of disabled, you cannot access your instance metadata.

      Default: enabled

      See Also:

    • httpProtocolIpv6

      public final InstanceMetadataProtocolState httpProtocolIpv6()

      Enables or disables the IPv6 endpoint for the instance metadata service.

      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:
      Enables or disables the IPv6 endpoint for the instance metadata service.

      Default: disabled

      See Also:

    • httpProtocolIpv6AsString

      public final String httpProtocolIpv6AsString()

      Enables or disables the IPv6 endpoint for the instance metadata service.

      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:
      Enables or disables the IPv6 endpoint for the instance metadata service.

      Default: disabled

      See Also:

    • instanceMetadataTags

      public final InstanceMetadataTagsState instanceMetadataTags()

      Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.

      Default: disabled

      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:
      Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.

      Default: disabled

      See Also:

    • instanceMetadataTagsAsString

      public final String instanceMetadataTagsAsString()

      Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.

      Default: disabled

      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:
      Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.

      Default: disabled

      See Also:

    • toBuilder

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

    • builder

      public static InstanceMetadataOptionsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends InstanceMetadataOptionsRequest.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.