java.lang.Object
- software.amazon.awssdk.services.autoscaling.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 instances. For more information, see Configuring the Instance Metadata Options in the Amazon EC2 Auto Scaling User Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface InstanceMetadataOptions.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static InstanceMetadataOptions.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`InstanceMetadataEndpointState`	`httpEndpoint()`	This parameter enables or disables the HTTP metadata endpoint on your instances.
`String`	`httpEndpointAsString()`	This parameter enables or disables the HTTP metadata endpoint on your instances.
`Integer`	`httpPutResponseHopLimit()`	The desired HTTP PUT response hop limit for instance metadata requests.
`InstanceMetadataHttpTokensState`	`httpTokens()`	The state of token usage for your instance metadata requests.
`String`	`httpTokensAsString()`	The state of token usage for your instance metadata requests.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends InstanceMetadataOptions.Builder>`	`serializableBuilderClass()`
`InstanceMetadataOptions.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - httpTokens
```
public final InstanceMetadataHttpTokensState 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 to retrieve instance metadata with or without 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 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 any instance metadata retrieval requests. In this state, retrieving the IAM role credentials 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 InstanceMetadataHttpTokensState.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 to retrieve instance metadata with or without 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 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 any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.
    
    See Also:
    
    InstanceMetadataHttpTokensState
  - 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 to retrieve instance metadata with or without 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 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 any instance metadata retrieval requests. In this state, retrieving the IAM role credentials 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 InstanceMetadataHttpTokensState.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 to retrieve instance metadata with or without 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 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 any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.
    
    See Also:
    
    InstanceMetadataHttpTokensState
  - 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.
    
    Default: 1
    
    Returns:
    
    The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
    
    Default: 1
  - httpEndpoint
```
public final InstanceMetadataEndpointState httpEndpoint()
```
    This parameter 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 InstanceMetadataEndpointState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from httpEndpointAsString().
    
    Returns:
    
    This parameter 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:
    
    InstanceMetadataEndpointState
  - httpEndpointAsString
```
public final String httpEndpointAsString()
```
    This parameter 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 InstanceMetadataEndpointState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from httpEndpointAsString().
    
    Returns:
    
    This parameter 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:
    
    InstanceMetadataEndpointState
  - toBuilder
```
public InstanceMetadataOptions.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<InstanceMetadataOptions.Builder,InstanceMetadataOptions>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class InstanceMetadataOptions

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

httpTokens

httpTokensAsString

httpPutResponseHopLimit

httpEndpoint

httpEndpointAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields