Class InstanceMetadataOptionsRequest
- java.lang.Object
-
- software.amazon.awssdk.services.ec2.model.InstanceMetadataOptionsRequest
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<InstanceMetadataOptionsRequest.Builder,InstanceMetadataOptionsRequest>
@Generated("software.amazon.awssdk:codegen") public final class InstanceMetadataOptionsRequest extends Object implements SdkPojo, Serializable, ToCopyableBuilder<InstanceMetadataOptionsRequest.Builder,InstanceMetadataOptionsRequest>
The metadata options for the instance.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
InstanceMetadataOptionsRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static InstanceMetadataOptionsRequest.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
InstanceMetadataEndpointState
httpEndpoint()
Enables or disables the HTTP metadata endpoint on your instances.String
httpEndpointAsString()
Enables or disables the HTTP metadata endpoint on your instances.InstanceMetadataProtocolState
httpProtocolIpv6()
Enables or disables the IPv6 endpoint for the instance metadata service.String
httpProtocolIpv6AsString()
Enables or disables the IPv6 endpoint for the instance metadata service.Integer
httpPutResponseHopLimit()
The desired HTTP PUT response hop limit for instance metadata requests.HttpTokensState
httpTokens()
Indicates whether IMDSv2 is required.String
httpTokensAsString()
Indicates whether IMDSv2 is required.InstanceMetadataTagsState
instanceMetadataTags()
Set toenabled
to allow access to instance tags from the instance metadata.String
instanceMetadataTagsAsString()
Set toenabled
to allow access to instance tags from the instance metadata.List<SdkField<?>>
sdkFields()
static Class<? extends InstanceMetadataOptionsRequest.Builder>
serializableBuilderClass()
InstanceMetadataOptionsRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
httpTokens
public final 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
.If the service returns an enum value that is not available in the current SDK version,
httpTokens
will returnHttpTokensState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhttpTokensAsString()
.- Returns:
- 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
. -
- See Also:
HttpTokensState
-
-
httpTokensAsString
public final String httpTokensAsString()
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
.If the service returns an enum value that is not available in the current SDK version,
httpTokens
will returnHttpTokensState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhttpTokensAsString()
.- Returns:
- 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
. -
- See Also:
HttpTokensState
-
-
httpPutResponseHopLimit
public final 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
- 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
Possible values: Integers from 1 to 64
-
httpEndpoint
public final 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
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:
- 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
- See Also:
InstanceMetadataEndpointState
-
httpEndpointAsString
public final String httpEndpointAsString()
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
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:
- 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
- See Also:
InstanceMetadataEndpointState
-
httpProtocolIpv6
public final InstanceMetadataProtocolState httpProtocolIpv6()
Enables or disables the IPv6 endpoint for the instance metadata service.
If the service returns an enum value that is not available in the current SDK version,
httpProtocolIpv6
will returnInstanceMetadataProtocolState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhttpProtocolIpv6AsString()
.- Returns:
- Enables or disables the IPv6 endpoint for the instance metadata service.
- See Also:
InstanceMetadataProtocolState
-
httpProtocolIpv6AsString
public final String httpProtocolIpv6AsString()
Enables or disables the IPv6 endpoint for the instance metadata service.
If the service returns an enum value that is not available in the current SDK version,
httpProtocolIpv6
will returnInstanceMetadataProtocolState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhttpProtocolIpv6AsString()
.- Returns:
- Enables or disables the IPv6 endpoint for the instance metadata service.
- See Also:
InstanceMetadataProtocolState
-
instanceMetadataTags
public final 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
If the service returns an enum value that is not available in the current SDK version,
instanceMetadataTags
will returnInstanceMetadataTagsState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceMetadataTagsAsString()
.- Returns:
- 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
- See Also:
InstanceMetadataTagsState
-
instanceMetadataTagsAsString
public final String instanceMetadataTagsAsString()
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
If the service returns an enum value that is not available in the current SDK version,
instanceMetadataTags
will returnInstanceMetadataTagsState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceMetadataTagsAsString()
.- Returns:
- 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
- See Also:
InstanceMetadataTagsState
-
toBuilder
public InstanceMetadataOptionsRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<InstanceMetadataOptionsRequest.Builder,InstanceMetadataOptionsRequest>
-
builder
public static InstanceMetadataOptionsRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends InstanceMetadataOptionsRequest.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String 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.
-
-