Interface InstanceMetadataOptionsRequest.Builder
-
- All Superinterfaces:
Buildable
,CopyableBuilder<InstanceMetadataOptionsRequest.Builder,InstanceMetadataOptionsRequest>
,SdkBuilder<InstanceMetadataOptionsRequest.Builder,InstanceMetadataOptionsRequest>
,SdkPojo
- Enclosing class:
- InstanceMetadataOptionsRequest
public static interface InstanceMetadataOptionsRequest.Builder extends SdkPojo, CopyableBuilder<InstanceMetadataOptionsRequest.Builder,InstanceMetadataOptionsRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description InstanceMetadataOptionsRequest.Builder
httpEndpoint(String httpEndpoint)
Enables or disables the HTTP metadata endpoint on your instances.InstanceMetadataOptionsRequest.Builder
httpEndpoint(InstanceMetadataEndpointState httpEndpoint)
Enables or disables the HTTP metadata endpoint on your instances.InstanceMetadataOptionsRequest.Builder
httpProtocolIpv6(String httpProtocolIpv6)
Enables or disables the IPv6 endpoint for the instance metadata service.InstanceMetadataOptionsRequest.Builder
httpProtocolIpv6(InstanceMetadataProtocolState httpProtocolIpv6)
Enables or disables the IPv6 endpoint for the instance metadata service.InstanceMetadataOptionsRequest.Builder
httpPutResponseHopLimit(Integer httpPutResponseHopLimit)
The desired HTTP PUT response hop limit for instance metadata requests.InstanceMetadataOptionsRequest.Builder
httpTokens(String httpTokens)
Indicates whether IMDSv2 is required.InstanceMetadataOptionsRequest.Builder
httpTokens(HttpTokensState httpTokens)
Indicates whether IMDSv2 is required.InstanceMetadataOptionsRequest.Builder
instanceMetadataTags(String instanceMetadataTags)
Set toenabled
to allow access to instance tags from the instance metadata.InstanceMetadataOptionsRequest.Builder
instanceMetadataTags(InstanceMetadataTagsState instanceMetadataTags)
Set toenabled
to allow access to instance tags from the instance metadata.-
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
InstanceMetadataOptionsRequest.Builder httpTokens(String 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.
Default: If the value of
ImdsSupport
for the Amazon Machine Image (AMI) for your instance isv2.0
, the default isrequired
.- Parameters:
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.
Default: If the value of
ImdsSupport
for the Amazon Machine Image (AMI) for your instance isv2.0
, the default isrequired
.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
HttpTokensState
,HttpTokensState
-
-
httpTokens
InstanceMetadataOptionsRequest.Builder httpTokens(HttpTokensState 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.
Default: If the value of
ImdsSupport
for the Amazon Machine Image (AMI) for your instance isv2.0
, the default isrequired
.- Parameters:
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.
Default: If the value of
ImdsSupport
for the Amazon Machine Image (AMI) for your instance isv2.0
, the default isrequired
.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
HttpTokensState
,HttpTokensState
-
-
httpPutResponseHopLimit
InstanceMetadataOptionsRequest.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
InstanceMetadataOptionsRequest.Builder httpEndpoint(String httpEndpoint)
Enables or disables the HTTP metadata endpoint on your instances.
If you specify a value of
disabled
, you cannot access your instance metadata.Default:
enabled
- Parameters:
httpEndpoint
- Enables or disables the HTTP metadata endpoint on your instances.If you specify a value of
disabled
, you cannot access your instance metadata.Default:
enabled
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
InstanceMetadataEndpointState
,InstanceMetadataEndpointState
-
httpEndpoint
InstanceMetadataOptionsRequest.Builder httpEndpoint(InstanceMetadataEndpointState httpEndpoint)
Enables or disables the HTTP metadata endpoint on your instances.
If you specify a value of
disabled
, you cannot access your instance metadata.Default:
enabled
- Parameters:
httpEndpoint
- Enables or disables the HTTP metadata endpoint on your instances.If you specify a value of
disabled
, you cannot access your instance metadata.Default:
enabled
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
InstanceMetadataEndpointState
,InstanceMetadataEndpointState
-
httpProtocolIpv6
InstanceMetadataOptionsRequest.Builder httpProtocolIpv6(String httpProtocolIpv6)
Enables or disables the IPv6 endpoint for the instance metadata service.
- Parameters:
httpProtocolIpv6
- Enables or disables the IPv6 endpoint for the instance metadata service.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
InstanceMetadataProtocolState
,InstanceMetadataProtocolState
-
httpProtocolIpv6
InstanceMetadataOptionsRequest.Builder httpProtocolIpv6(InstanceMetadataProtocolState httpProtocolIpv6)
Enables or disables the IPv6 endpoint for the instance metadata service.
- Parameters:
httpProtocolIpv6
- Enables or disables the IPv6 endpoint for the instance metadata service.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
InstanceMetadataProtocolState
,InstanceMetadataProtocolState
-
instanceMetadataTags
InstanceMetadataOptionsRequest.Builder instanceMetadataTags(String instanceMetadataTags)
Set to
enabled
to allow access to instance tags from the instance metadata. Set todisabled
to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.Default:
disabled
- Parameters:
instanceMetadataTags
- Set toenabled
to allow access to instance tags from the instance metadata. Set todisabled
to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.Default:
disabled
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
InstanceMetadataTagsState
,InstanceMetadataTagsState
-
instanceMetadataTags
InstanceMetadataOptionsRequest.Builder instanceMetadataTags(InstanceMetadataTagsState instanceMetadataTags)
Set to
enabled
to allow access to instance tags from the instance metadata. Set todisabled
to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.Default:
disabled
- Parameters:
instanceMetadataTags
- Set toenabled
to allow access to instance tags from the instance metadata. Set todisabled
to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.Default:
disabled
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
InstanceMetadataTagsState
,InstanceMetadataTagsState
-
-