Class InstanceMetadataOptions

java.lang.Object
software.amazon.awssdk.services.imagebuilder.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 instance metadata options that apply to the HTTP requests that pipeline builds use to launch EC2 build and test instances. For more information about instance metadata options, see Configure the instance metadata options in the Amazon EC2 User Guide for Linux instances, or Configure the instance metadata options in the Amazon EC2 Windows Guide for Windows instances.

See Also:

  • Method Details

    • httpTokens

      public final String httpTokens()

      Indicates whether a signed token header is required for instance metadata retrieval requests. The values affect the response as follows:

      • required – When you retrieve the IAM role credentials, version 2.0 credentials are returned in all cases.

      • optional – You can include a signed token header in your request to retrieve instance metadata, or you can leave it out. If you include it, version 2.0 credentials are returned for the IAM role. Otherwise, version 1.0 credentials are returned.

      The default setting is optional.

      Returns:
      Indicates whether a signed token header is required for instance metadata retrieval requests. The values affect the response as follows:

      • required – When you retrieve the IAM role credentials, version 2.0 credentials are returned in all cases.

      • optional – You can include a signed token header in your request to retrieve instance metadata, or you can leave it out. If you include it, version 2.0 credentials are returned for the IAM role. Otherwise, version 1.0 credentials are returned.

      The default setting is optional.

    • httpPutResponseHopLimit

      public final Integer httpPutResponseHopLimit()

      Limit the number of hops that an instance metadata request can traverse to reach its destination. The default is one hop. However, if HTTP tokens are required, container image builds need a minimum of two hops.

      Returns:
      Limit the number of hops that an instance metadata request can traverse to reach its destination. The default is one hop. However, if HTTP tokens are required, container image builds need a minimum of two hops.

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