Class InstanceMetadataOptions
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
This parameter enables or disables the HTTP metadata endpoint on your instances.final String
This parameter enables or disables the HTTP metadata endpoint on your instances.final Integer
The desired HTTP PUT response hop limit for instance metadata requests.The state of token usage for your instance metadata requests.final String
The state of token usage for your instance metadata requests.static Class
<? extends InstanceMetadataOptions.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 returnInstanceMetadataHttpTokensState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhttpTokensAsString()
.- 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:
-
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 returnInstanceMetadataHttpTokensState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhttpTokensAsString()
.- 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:
-
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
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 returnInstanceMetadataEndpointState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhttpEndpointAsString()
.- 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:
-
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 returnInstanceMetadataEndpointState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhttpEndpointAsString()
.- 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:
-
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 interfaceToCopyableBuilder<InstanceMetadataOptions.Builder,
InstanceMetadataOptions> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-