Class LaunchTemplateInstanceMetadataOptions

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

The metadata options for the instance. For more information, see Use instance metadata to manage your EC2 instance in the Amazon EC2 User Guide.

See Also:

  • Method Details

    • state

      public final LaunchTemplateInstanceMetadataOptionsState 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 LaunchTemplateInstanceMetadataOptionsState.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 LaunchTemplateInstanceMetadataOptionsState.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 LaunchTemplateHttpTokensState httpTokens()

      Indicates whether IMDSv2 is required.

      • optional - IMDSv2 is optional. You can choose whether to send a session token in your instance metadata retrieval requests. If you retrieve IAM role credentials without a session token, you receive the IMDSv1 role credentials. If you retrieve IAM role credentials using a valid session token, you receive the IMDSv2 role credentials.

      • required - IMDSv2 is required. You must send a session token in your instance metadata retrieval requests. With this option, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.

      If the service returns an enum value that is not available in the current SDK version, httpTokens will return LaunchTemplateHttpTokensState.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. You can choose whether to send a session token in your instance metadata retrieval requests. If you retrieve IAM role credentials without a session token, you receive the IMDSv1 role credentials. If you retrieve IAM role credentials using a valid session token, you receive the IMDSv2 role credentials.

      • required - IMDSv2 is required. You must send a session token in your instance metadata retrieval requests. With this option, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.

      See Also:

    • httpTokensAsString

      public final String httpTokensAsString()

      Indicates whether IMDSv2 is required.

      • optional - IMDSv2 is optional. You can choose whether to send a session token in your instance metadata retrieval requests. If you retrieve IAM role credentials without a session token, you receive the IMDSv1 role credentials. If you retrieve IAM role credentials using a valid session token, you receive the IMDSv2 role credentials.

      • required - IMDSv2 is required. You must send a session token in your instance metadata retrieval requests. With this option, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.

      If the service returns an enum value that is not available in the current SDK version, httpTokens will return LaunchTemplateHttpTokensState.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. You can choose whether to send a session token in your instance metadata retrieval requests. If you retrieve IAM role credentials without a session token, you receive the IMDSv1 role credentials. If you retrieve IAM role credentials using a valid session token, you receive the IMDSv2 role credentials.

      • required - IMDSv2 is required. You must send a session token in your instance metadata retrieval requests. With this option, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.

      See Also:

    • httpPutResponseHopLimit

      public final Integer httpPutResponseHopLimit()

      The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.

      Possible values: Integers from 1 to 64

      Returns:
      The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.

      Possible values: Integers from 1 to 64

    • httpEndpoint

      public final LaunchTemplateInstanceMetadataEndpointState httpEndpoint()

      Enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled.

      If you specify a value of disabled, you will not be able to access your instance metadata.

      If the service returns an enum value that is not available in the current SDK version, httpEndpoint will return LaunchTemplateInstanceMetadataEndpointState.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 the parameter is not specified, the default state is enabled.

      If you specify a value of disabled, you will not be able to access your instance metadata.

      See Also:

    • httpEndpointAsString

      public final String httpEndpointAsString()

      Enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled.

      If you specify a value of disabled, you will not be able to access your instance metadata.

      If the service returns an enum value that is not available in the current SDK version, httpEndpoint will return LaunchTemplateInstanceMetadataEndpointState.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 the parameter is not specified, the default state is enabled.

      If you specify a value of disabled, you will not be able to access your instance metadata.

      See Also:

    • httpProtocolIpv6

      public final LaunchTemplateInstanceMetadataProtocolIpv6 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 LaunchTemplateInstanceMetadataProtocolIpv6.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 LaunchTemplateInstanceMetadataProtocolIpv6.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 LaunchTemplateInstanceMetadataTagsState 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 View tags for your EC2 instances using instance metadata.

      Default: disabled

      If the service returns an enum value that is not available in the current SDK version, instanceMetadataTags will return LaunchTemplateInstanceMetadataTagsState.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 View tags for your EC2 instances using 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 View tags for your EC2 instances using instance metadata.

      Default: disabled

      If the service returns an enum value that is not available in the current SDK version, instanceMetadataTags will return LaunchTemplateInstanceMetadataTagsState.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 View tags for your EC2 instances using instance metadata.

      Default: disabled

      See Also:

    • toBuilder

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

    • builder

      public static LaunchTemplateInstanceMetadataOptions.Builder builder()

    • serializableBuilderClass

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