Interface InstanceMetadataOptionsResponse.Builder
-
- All Superinterfaces:
Buildable
,CopyableBuilder<InstanceMetadataOptionsResponse.Builder,InstanceMetadataOptionsResponse>
,SdkBuilder<InstanceMetadataOptionsResponse.Builder,InstanceMetadataOptionsResponse>
,SdkPojo
- Enclosing class:
- InstanceMetadataOptionsResponse
public static interface InstanceMetadataOptionsResponse.Builder extends SdkPojo, CopyableBuilder<InstanceMetadataOptionsResponse.Builder,InstanceMetadataOptionsResponse>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description InstanceMetadataOptionsResponse.Builder
httpEndpoint(String httpEndpoint)
Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.InstanceMetadataOptionsResponse.Builder
httpEndpoint(InstanceMetadataEndpointState httpEndpoint)
Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.InstanceMetadataOptionsResponse.Builder
httpProtocolIpv6(String httpProtocolIpv6)
Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.InstanceMetadataOptionsResponse.Builder
httpProtocolIpv6(InstanceMetadataProtocolState httpProtocolIpv6)
Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.InstanceMetadataOptionsResponse.Builder
httpPutResponseHopLimit(Integer httpPutResponseHopLimit)
The desired HTTP PUT response hop limit for instance metadata requests.InstanceMetadataOptionsResponse.Builder
httpTokens(String httpTokens)
IMDSv2 uses token-backed sessions.InstanceMetadataOptionsResponse.Builder
httpTokens(HttpTokensState httpTokens)
IMDSv2 uses token-backed sessions.InstanceMetadataOptionsResponse.Builder
instanceMetadataTags(String instanceMetadataTags)
Indicates whether access to instance tags from the instance metadata is enabled or disabled.InstanceMetadataOptionsResponse.Builder
instanceMetadataTags(InstanceMetadataTagsState instanceMetadataTags)
Indicates whether access to instance tags from the instance metadata is enabled or disabled.InstanceMetadataOptionsResponse.Builder
state(String state)
The state of the metadata option changes.InstanceMetadataOptionsResponse.Builder
state(InstanceMetadataOptionsState state)
The state of the metadata option changes.-
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
-
state
InstanceMetadataOptionsResponse.Builder state(String 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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
InstanceMetadataOptionsState
,InstanceMetadataOptionsState
-
state
InstanceMetadataOptionsResponse.Builder state(InstanceMetadataOptionsState 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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
InstanceMetadataOptionsState
,InstanceMetadataOptionsState
-
httpTokens
InstanceMetadataOptionsResponse.Builder httpTokens(String httpTokens)
IMDSv2 uses token-backed sessions. Indicates whether the use of HTTP tokens is
optional
(in other words, indicates whether the use of IMDSv2 isoptional
) orrequired
(in other words, indicates whether the use of IMDSv2 isrequired
).-
optional
- When IMDSv2 is optional, you can choose to retrieve instance metadata with or without a session token in your request. If you retrieve the IAM role credentials without a token, the IMDSv1 role credentials are returned. If you retrieve the IAM role credentials using a valid session token, the IMDSv2 role credentials are returned. -
required
- When IMDSv2 is required, you must send a session token with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.
Default:
optional
- Parameters:
httpTokens
- IMDSv2 uses token-backed sessions. Indicates whether the use of HTTP tokens isoptional
(in other words, indicates whether the use of IMDSv2 isoptional
) orrequired
(in other words, indicates whether the use of IMDSv2 isrequired
).-
optional
- When IMDSv2 is optional, you can choose to retrieve instance metadata with or without a session token in your request. If you retrieve the IAM role credentials without a token, the IMDSv1 role credentials are returned. If you retrieve the IAM role credentials using a valid session token, the IMDSv2 role credentials are returned. -
required
- When IMDSv2 is required, you must send a session token with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.
Default:
optional
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
HttpTokensState
,HttpTokensState
-
-
httpTokens
InstanceMetadataOptionsResponse.Builder httpTokens(HttpTokensState httpTokens)
IMDSv2 uses token-backed sessions. Indicates whether the use of HTTP tokens is
optional
(in other words, indicates whether the use of IMDSv2 isoptional
) orrequired
(in other words, indicates whether the use of IMDSv2 isrequired
).-
optional
- When IMDSv2 is optional, you can choose to retrieve instance metadata with or without a session token in your request. If you retrieve the IAM role credentials without a token, the IMDSv1 role credentials are returned. If you retrieve the IAM role credentials using a valid session token, the IMDSv2 role credentials are returned. -
required
- When IMDSv2 is required, you must send a session token with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.
Default:
optional
- Parameters:
httpTokens
- IMDSv2 uses token-backed sessions. Indicates whether the use of HTTP tokens isoptional
(in other words, indicates whether the use of IMDSv2 isoptional
) orrequired
(in other words, indicates whether the use of IMDSv2 isrequired
).-
optional
- When IMDSv2 is optional, you can choose to retrieve instance metadata with or without a session token in your request. If you retrieve the IAM role credentials without a token, the IMDSv1 role credentials are returned. If you retrieve the IAM role credentials using a valid session token, the IMDSv2 role credentials are returned. -
required
- When IMDSv2 is required, you must send a session token with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.
Default:
optional
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
HttpTokensState
,HttpTokensState
-
-
httpPutResponseHopLimit
InstanceMetadataOptionsResponse.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
Possible values: Integers from 1 to 64
- 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
Possible values: Integers from 1 to 64
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
httpEndpoint
InstanceMetadataOptionsResponse.Builder httpEndpoint(String httpEndpoint)
Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.
If the value is
disabled
, you cannot access your instance metadata.- Parameters:
httpEndpoint
- Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.If the value is
disabled
, you cannot access your instance metadata.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
InstanceMetadataEndpointState
,InstanceMetadataEndpointState
-
httpEndpoint
InstanceMetadataOptionsResponse.Builder httpEndpoint(InstanceMetadataEndpointState httpEndpoint)
Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.
If the value is
disabled
, you cannot access your instance metadata.- Parameters:
httpEndpoint
- Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.If the value is
disabled
, you cannot access your instance metadata.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
InstanceMetadataEndpointState
,InstanceMetadataEndpointState
-
httpProtocolIpv6
InstanceMetadataOptionsResponse.Builder httpProtocolIpv6(String httpProtocolIpv6)
Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.
- Parameters:
httpProtocolIpv6
- Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
InstanceMetadataProtocolState
,InstanceMetadataProtocolState
-
httpProtocolIpv6
InstanceMetadataOptionsResponse.Builder httpProtocolIpv6(InstanceMetadataProtocolState httpProtocolIpv6)
Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.
- Parameters:
httpProtocolIpv6
- Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
InstanceMetadataProtocolState
,InstanceMetadataProtocolState
-
instanceMetadataTags
InstanceMetadataOptionsResponse.Builder instanceMetadataTags(String instanceMetadataTags)
Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see Work with instance tags using the instance metadata.
- Parameters:
instanceMetadataTags
- Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see Work with instance tags using the instance metadata.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
InstanceMetadataTagsState
,InstanceMetadataTagsState
-
instanceMetadataTags
InstanceMetadataOptionsResponse.Builder instanceMetadataTags(InstanceMetadataTagsState instanceMetadataTags)
Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see Work with instance tags using the instance metadata.
- Parameters:
instanceMetadataTags
- Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see Work with instance tags using the instance metadata.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
InstanceMetadataTagsState
,InstanceMetadataTagsState
-
-