Package software.amazon.awssdk.services.lightsail.model

Class UpdateInstanceMetadataOptionsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.lightsail.model.LightsailRequest
software.amazon.awssdk.services.lightsail.model.UpdateInstanceMetadataOptionsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateInstanceMetadataOptionsRequest.Builder,UpdateInstanceMetadataOptionsRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateInstanceMetadataOptionsRequest extends LightsailRequest implements ToCopyableBuilder<UpdateInstanceMetadataOptionsRequest.Builder,UpdateInstanceMetadataOptionsRequest>

  • Method Details

    • instanceName

      public final String instanceName()

      The name of the instance for which to update metadata parameters.

      Returns:
      The name of the instance for which to update metadata parameters.

    • httpTokens

      public final HttpTokens httpTokens()

      The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional.

      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.

      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 parameter is not specified in the request, the default state is optional.

      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.

      See Also:

    • httpTokensAsString

      public final String httpTokensAsString()

      The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional.

      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.

      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 parameter is not specified in the request, the default state is optional.

      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.

      See Also:

    • httpEndpoint

      public final HttpEndpoint httpEndpoint()

      Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained.

      If you specify a value of 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:
      Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained.

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

      See Also:

    • httpEndpointAsString

      public final String httpEndpointAsString()

      Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained.

      If you specify a value of 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:
      Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained.

      If you specify a value of 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. If no parameter is specified, the existing state is maintained.

      Returns:
      The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the instance metadata requests can travel farther. If no parameter is specified, the existing state is maintained.

    • httpProtocolIpv6

      public final HttpProtocolIpv6 httpProtocolIpv6()

      Enables or disables the IPv6 endpoint for the instance metadata service. This setting applies only when the HTTP metadata endpoint is enabled.

      This parameter is available only for instances in the Europe (Stockholm) Amazon Web Services Region ( eu-north-1).

      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:
      Enables or disables the IPv6 endpoint for the instance metadata service. This setting applies only when the HTTP metadata endpoint is enabled.

      This parameter is available only for instances in the Europe (Stockholm) Amazon Web Services Region ( eu-north-1).

      See Also:

    • httpProtocolIpv6AsString

      public final String httpProtocolIpv6AsString()

      Enables or disables the IPv6 endpoint for the instance metadata service. This setting applies only when the HTTP metadata endpoint is enabled.

      This parameter is available only for instances in the Europe (Stockholm) Amazon Web Services Region ( eu-north-1).

      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:
      Enables or disables the IPv6 endpoint for the instance metadata service. This setting applies only when the HTTP metadata endpoint is enabled.

      This parameter is available only for instances in the Europe (Stockholm) Amazon Web Services Region ( eu-north-1).

      See Also:

    • toBuilder

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

    • builder

      public static UpdateInstanceMetadataOptionsRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.