Class InstanceMetadataOptions

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

The metadata options for the instance.

See Also:

  • Method Details

    • state

      public final InstanceMetadataState state()

      The state of the metadata option changes.

      The following states are possible:

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

      • applied - The metadata options have been successfully applied to the instance.

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

      Returns:
      The state of the metadata option changes.

      The following states are possible:

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

      • applied - The metadata options have been successfully applied to the instance.

      See Also:

    • stateAsString

      public final String stateAsString()

      The state of the metadata option changes.

      The following states are possible:

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

      • applied - The metadata options have been successfully applied to the instance.

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

      Returns:
      The state of the metadata option changes.

      The following states are possible:

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

      • applied - The metadata options have been successfully applied to the instance.

      See Also:

    • httpTokens

      public final HttpTokens httpTokens()

      The state of token usage for your instance metadata requests.

      If the state is optional, you can choose whether to retrieve instance metadata with a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials by using a valid signed token, the version 2.0 role credentials are returned.

      If the state is required, you must send a signed token header with all instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The version 1.0 credentials are not available.

      Not all instance blueprints in Lightsail support version 2.0 credentials. Use the MetadataNoToken instance metric to track the number of calls to the instance metadata service that are using version 1.0 credentials. For more information, see Viewing instance metrics in Amazon Lightsail in the Amazon Lightsail Developer Guide.

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

      Returns:
      The state of token usage for your instance metadata requests.

      If the state is optional, you can choose whether to retrieve instance metadata with a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials by using a valid signed token, the version 2.0 role credentials are returned.

      If the state is required, you must send a signed token header with all instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The version 1.0 credentials are not available.

      Not all instance blueprints in Lightsail support version 2.0 credentials. Use the MetadataNoToken instance metric to track the number of calls to the instance metadata service that are using version 1.0 credentials. For more information, see Viewing instance metrics in Amazon Lightsail in the Amazon Lightsail Developer Guide.

      See Also:

    • httpTokensAsString

      public final String httpTokensAsString()

      The state of token usage for your instance metadata requests.

      If the state is optional, you can choose whether to retrieve instance metadata with a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials by using a valid signed token, the version 2.0 role credentials are returned.

      If the state is required, you must send a signed token header with all instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The version 1.0 credentials are not available.

      Not all instance blueprints in Lightsail support version 2.0 credentials. Use the MetadataNoToken instance metric to track the number of calls to the instance metadata service that are using version 1.0 credentials. For more information, see Viewing instance metrics in Amazon Lightsail in the Amazon Lightsail Developer Guide.

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

      Returns:
      The state of token usage for your instance metadata requests.

      If the state is optional, you can choose whether to retrieve instance metadata with a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials by using a valid signed token, the version 2.0 role credentials are returned.

      If the state is required, you must send a signed token header with all instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The version 1.0 credentials are not available.

      Not all instance blueprints in Lightsail support version 2.0 credentials. Use the MetadataNoToken instance metric to track the number of calls to the instance metadata service that are using version 1.0 credentials. For more information, see Viewing instance metrics in Amazon Lightsail in the Amazon Lightsail Developer Guide.

      See Also:

    • httpEndpoint

      public final HttpEndpoint 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 HttpEndpoint.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 HttpEndpoint.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:

    • httpPutResponseHopLimit

      public final Integer httpPutResponseHopLimit()

      The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the instance metadata requests can travel farther.

      Returns:
      The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the instance metadata requests can travel farther.

    • httpProtocolIpv6

      public final HttpProtocolIpv6 httpProtocolIpv6()

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

      If the service returns an enum value that is not available in the current SDK version, httpProtocolIpv6 will return HttpProtocolIpv6.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.
      See Also:

    • httpProtocolIpv6AsString

      public final String httpProtocolIpv6AsString()

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

      If the service returns an enum value that is not available in the current SDK version, httpProtocolIpv6 will return HttpProtocolIpv6.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.
      See Also:

    • toBuilder

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

    • builder

      public static InstanceMetadataOptions.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.