Interface InstanceMetadataOptions.Builder
-
- All Superinterfaces:
Buildable
,CopyableBuilder<InstanceMetadataOptions.Builder,InstanceMetadataOptions>
,SdkBuilder<InstanceMetadataOptions.Builder,InstanceMetadataOptions>
,SdkPojo
- Enclosing class:
- InstanceMetadataOptions
public static interface InstanceMetadataOptions.Builder extends SdkPojo, CopyableBuilder<InstanceMetadataOptions.Builder,InstanceMetadataOptions>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description InstanceMetadataOptions.Builder
httpEndpoint(String httpEndpoint)
This parameter enables or disables the HTTP metadata endpoint on your instances.InstanceMetadataOptions.Builder
httpEndpoint(InstanceMetadataEndpointState httpEndpoint)
This parameter enables or disables the HTTP metadata endpoint on your instances.InstanceMetadataOptions.Builder
httpPutResponseHopLimit(Integer httpPutResponseHopLimit)
The desired HTTP PUT response hop limit for instance metadata requests.InstanceMetadataOptions.Builder
httpTokens(String httpTokens)
The state of token usage for your instance metadata requests.InstanceMetadataOptions.Builder
httpTokens(InstanceMetadataHttpTokensState httpTokens)
The state of token usage for your instance metadata requests.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
httpTokens
InstanceMetadataOptions.Builder httpTokens(String 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.- Parameters:
httpTokens
- The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state isoptional
.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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
InstanceMetadataHttpTokensState
,InstanceMetadataHttpTokensState
-
httpTokens
InstanceMetadataOptions.Builder httpTokens(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.- Parameters:
httpTokens
- The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state isoptional
.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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
InstanceMetadataHttpTokensState
,InstanceMetadataHttpTokensState
-
httpPutResponseHopLimit
InstanceMetadataOptions.Builder httpPutResponseHopLimit(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
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
httpEndpoint
InstanceMetadataOptions.Builder httpEndpoint(String 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.- Parameters:
httpEndpoint
- This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state isenabled
.If you specify a value of
disabled
, you will not be able to access your instance metadata.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
InstanceMetadataEndpointState
,InstanceMetadataEndpointState
-
httpEndpoint
InstanceMetadataOptions.Builder httpEndpoint(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.- Parameters:
httpEndpoint
- This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state isenabled
.If you specify a value of
disabled
, you will not be able to access your instance metadata.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
InstanceMetadataEndpointState
,InstanceMetadataEndpointState
-
-