java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.ec2.model.Ec2Request
    - - software.amazon.awssdk.services.ec2.model.ModifyInstanceMetadataOptionsRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<ModifyInstanceMetadataOptionsRequest.Builder,ModifyInstanceMetadataOptionsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ModifyInstanceMetadataOptionsRequest
extends Ec2Request
implements ToCopyableBuilder<ModifyInstanceMetadataOptionsRequest.Builder,ModifyInstanceMetadataOptionsRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ModifyInstanceMetadataOptionsRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ModifyInstanceMetadataOptionsRequest.Builder`	`builder()`
`Boolean`	`dryRun()`	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
`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.
`String`	`instanceId()`	The ID of the instance.
`InstanceMetadataTagsState`	`instanceMetadataTags()`	Set to `enabled` to allow access to instance tags from the instance metadata.
`String`	`instanceMetadataTagsAsString()`	Set to `enabled` to allow access to instance tags from the instance metadata.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ModifyInstanceMetadataOptionsRequest.Builder>`	`serializableBuilderClass()`
`ModifyInstanceMetadataOptionsRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - instanceId
```
public final String instanceId()
```
    The ID of the instance.
    
    Returns:
    
    The ID of the instance.
  - 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 is v2.0 and the account level default is set to no-preference, the default is required.
    
    If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0, but the account level default is set to V1 or V2, the default is optional.
    
    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.
    
    If the service returns an enum value that is not available in the current SDK version, httpTokens will return HttpTokensState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from httpTokensAsString().
    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 is v2.0 and the account level default is set to no-preference, the default is required.
    
    If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0, but the account level default is set to V1 or V2, the default is optional.
    
    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.
    
    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 is v2.0 and the account level default is set to no-preference, the default is required.
    
    If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0, but the account level default is set to V1 or V2, the default is optional.
    
    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.
    
    If the service returns an enum value that is not available in the current SDK version, httpTokens will return HttpTokensState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from httpTokensAsString().
    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 is v2.0 and the account level default is set to no-preference, the default is required.
    
    If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0, but the account level default is set to V1 or V2, the default is optional.
    
    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.
    
    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. If no parameter is specified, the existing state is maintained.
    
    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. If no parameter is specified, the existing state is maintained.
    
    Possible values: Integers from 1 to 64
  - httpEndpoint
```
public final InstanceMetadataEndpointState httpEndpoint()
```
    Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained.
    
    If you specify a value of disabled, you cannot access your instance metadata.
    
    If the service returns an enum value that is not available in the current SDK version, httpEndpoint will return InstanceMetadataEndpointState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from httpEndpointAsString().
    
    Returns:
    
    Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained.
    
    If you specify a value of disabled, you cannot access your instance metadata.
    
    See Also:
    
    InstanceMetadataEndpointState
  - httpEndpointAsString
```
public final String httpEndpointAsString()
```
    Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained.
    
    If you specify a value of disabled, you cannot access your instance metadata.
    
    If the service returns an enum value that is not available in the current SDK version, httpEndpoint will return InstanceMetadataEndpointState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from httpEndpointAsString().
    
    Returns:
    
    Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained.
    
    If you specify a value of disabled, you cannot access your instance metadata.
    
    See Also:
    
    InstanceMetadataEndpointState
  - dryRun
```
public final Boolean dryRun()
```
    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
    
    Returns:
    
    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
  - httpProtocolIpv6
```
public final InstanceMetadataProtocolState httpProtocolIpv6()
```
    Enables or disables the IPv6 endpoint for the instance metadata service. Applies only if you enabled the HTTP metadata endpoint.
    
    If the service returns an enum value that is not available in the current SDK version, httpProtocolIpv6 will return InstanceMetadataProtocolState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from httpProtocolIpv6AsString().
    
    Returns:
    
    Enables or disables the IPv6 endpoint for the instance metadata service. Applies only if you enabled the HTTP metadata endpoint.
    
    See Also:
    
    InstanceMetadataProtocolState
  - httpProtocolIpv6AsString
```
public final String httpProtocolIpv6AsString()
```
    Enables or disables the IPv6 endpoint for the instance metadata service. Applies only if you enabled the HTTP metadata endpoint.
    
    If the service returns an enum value that is not available in the current SDK version, httpProtocolIpv6 will return InstanceMetadataProtocolState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from httpProtocolIpv6AsString().
    
    Returns:
    
    Enables or disables the IPv6 endpoint for the instance metadata service. Applies only if you enabled the HTTP metadata endpoint.
    
    See Also:
    
    InstanceMetadataProtocolState
  - instanceMetadataTags
```
public final InstanceMetadataTagsState instanceMetadataTags()
```
    Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.
    
    If the service returns an enum value that is not available in the current SDK version, instanceMetadataTags will return InstanceMetadataTagsState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceMetadataTagsAsString().
    
    Returns:
    
    Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.
    
    See Also:
    
    InstanceMetadataTagsState
  - instanceMetadataTagsAsString
```
public final String instanceMetadataTagsAsString()
```
    Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.
    
    If the service returns an enum value that is not available in the current SDK version, instanceMetadataTags will return InstanceMetadataTagsState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceMetadataTagsAsString().
    
    Returns:
    
    Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.
    
    See Also:
    
    InstanceMetadataTagsState
  - toBuilder
```
public ModifyInstanceMetadataOptionsRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ModifyInstanceMetadataOptionsRequest.Builder,ModifyInstanceMetadataOptionsRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
  - builder
```
public static ModifyInstanceMetadataOptionsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ModifyInstanceMetadataOptionsRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class ModifyInstanceMetadataOptionsRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

instanceId

httpTokens

httpTokensAsString

httpPutResponseHopLimit

httpEndpoint

httpEndpointAsString

dryRun

httpProtocolIpv6

httpProtocolIpv6AsString

instanceMetadataTags

instanceMetadataTagsAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField