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 maximum number of hops that the metadata token can travel.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, which means that you can use either IMDSv2 or IMDSv1. -
required
- IMDSv2 is required, which means that IMDSv1 is disabled, and you must use IMDSv2.
Default:
-
If the value of
ImdsSupport
for the Amazon Machine Image (AMI) for your instance isv2.0
and the account level default is set tono-preference
, the default isrequired
. -
If the value of
ImdsSupport
for the Amazon Machine Image (AMI) for your instance isv2.0
, but the account level default is set toV1 or V2
, the default isoptional
.
The default value can also be affected by other combinations of parameters. For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.
- Parameters:
httpTokens
- Indicates whether IMDSv2 is required.-
optional
- IMDSv2 is optional, which means that you can use either IMDSv2 or IMDSv1. -
required
- IMDSv2 is required, which means that IMDSv1 is disabled, and you must use IMDSv2.
Default:
-
If the value of
ImdsSupport
for the Amazon Machine Image (AMI) for your instance isv2.0
and the account level default is set tono-preference
, the default isrequired
. -
If the value of
ImdsSupport
for the Amazon Machine Image (AMI) for your instance isv2.0
, but the account level default is set toV1 or V2
, the default isoptional
.
The default value can also be affected by other combinations of parameters. For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.
-
- 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, which means that you can use either IMDSv2 or IMDSv1. -
required
- IMDSv2 is required, which means that IMDSv1 is disabled, and you must use IMDSv2.
Default:
-
If the value of
ImdsSupport
for the Amazon Machine Image (AMI) for your instance isv2.0
and the account level default is set tono-preference
, the default isrequired
. -
If the value of
ImdsSupport
for the Amazon Machine Image (AMI) for your instance isv2.0
, but the account level default is set toV1 or V2
, the default isoptional
.
The default value can also be affected by other combinations of parameters. For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.
- Parameters:
httpTokens
- Indicates whether IMDSv2 is required.-
optional
- IMDSv2 is optional, which means that you can use either IMDSv2 or IMDSv1. -
required
- IMDSv2 is required, which means that IMDSv1 is disabled, and you must use IMDSv2.
Default:
-
If the value of
ImdsSupport
for the Amazon Machine Image (AMI) for your instance isv2.0
and the account level default is set tono-preference
, the default isrequired
. -
If the value of
ImdsSupport
for the Amazon Machine Image (AMI) for your instance isv2.0
, but the account level default is set toV1 or V2
, the default isoptional
.
The default value can also be affected by other combinations of parameters. For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.
-
- 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 maximum number of hops that the metadata token can travel.
Possible values: Integers from 1 to 64
- Parameters:
httpPutResponseHopLimit
- The maximum number of hops that the metadata token can travel.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.
Default:
disabled
- Parameters:
httpProtocolIpv6
- Enables or disables the IPv6 endpoint for the instance metadata service.Default:
disabled
- 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.
Default:
disabled
- Parameters:
httpProtocolIpv6
- Enables or disables the IPv6 endpoint for the instance metadata service.Default:
disabled
- 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
-
-