Package software.amazon.awssdk.services.ec2.model

Class ModifyInstanceMetadataDefaultsRequest

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.ModifyInstanceMetadataDefaultsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ModifyInstanceMetadataDefaultsRequest.Builder,ModifyInstanceMetadataDefaultsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ModifyInstanceMetadataDefaultsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ModifyInstanceMetadataDefaultsRequest.Builder	builder()
final Boolean	dryRun()	Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final DefaultInstanceMetadataEndpointState	httpEndpoint()	Enables or disables the IMDS endpoint on an instance.
final String	httpEndpointAsString()	Enables or disables the IMDS endpoint on an instance.
final Integer	httpPutResponseHopLimit()	The maximum number of hops that the metadata token can travel.
final MetadataDefaultHttpTokensState	httpTokens()	Indicates whether IMDSv2 is required.
final String	httpTokensAsString()	Indicates whether IMDSv2 is required.
final DefaultHttpTokensEnforcedState	httpTokensEnforced()	Specifies whether to enforce the requirement of IMDSv2 on an instance at the time of launch.
final String	httpTokensEnforcedAsString()	Specifies whether to enforce the requirement of IMDSv2 on an instance at the time of launch.
final DefaultInstanceMetadataTagsState	instanceMetadataTags()	Enables or disables access to an instance's tags from the instance metadata.
final String	instanceMetadataTagsAsString()	Enables or disables access to an instance's tags from the instance metadata.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends ModifyInstanceMetadataDefaultsRequest.Builder>	serializableBuilderClass()
ModifyInstanceMetadataDefaultsRequest.Builder	toBuilder()
final 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 Details

httpTokens

public final MetadataDefaultHttpTokensState 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.

If the service returns an enum value that is not available in the current SDK version, httpTokens will return MetadataDefaultHttpTokensState.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, 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.

See Also:

• MetadataDefaultHttpTokensState

httpTokensAsString

public final String httpTokensAsString()

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.

If the service returns an enum value that is not available in the current SDK version, httpTokens will return MetadataDefaultHttpTokensState.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, 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.

See Also:

• MetadataDefaultHttpTokensState

httpPutResponseHopLimit

public final Integer httpPutResponseHopLimit()

The maximum number of hops that the metadata token can travel. To indicate no preference, specify -1 .

Possible values: Integers from 1 to 64, and -1 to indicate no preference

Returns:

The maximum number of hops that the metadata token can travel. To indicate no preference, specify -1.

Possible values: Integers from 1 to 64, and -1 to indicate no preference

httpEndpoint

public final DefaultInstanceMetadataEndpointState httpEndpoint()

Enables or disables the IMDS endpoint on an instance. When disabled, the instance metadata can't be accessed.

If the service returns an enum value that is not available in the current SDK version, httpEndpoint will return DefaultInstanceMetadataEndpointState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from httpEndpointAsString().

Returns:

Enables or disables the IMDS endpoint on an instance. When disabled, the instance metadata can't be accessed.

See Also:

• DefaultInstanceMetadataEndpointState

httpEndpointAsString

public final String httpEndpointAsString()

Enables or disables the IMDS endpoint on an instance. When disabled, the instance metadata can't be accessed.

If the service returns an enum value that is not available in the current SDK version, httpEndpoint will return DefaultInstanceMetadataEndpointState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from httpEndpointAsString().

Returns:

Enables or disables the IMDS endpoint on an instance. When disabled, the instance metadata can't be accessed.

See Also:

• DefaultInstanceMetadataEndpointState

instanceMetadataTags

public final DefaultInstanceMetadataTagsState instanceMetadataTags()

Enables or disables access to an instance's tags from the instance metadata. For more information, see View tags for your EC2 instances using instance metadata in the Amazon EC2 User Guide.

If the service returns an enum value that is not available in the current SDK version, instanceMetadataTags will return DefaultInstanceMetadataTagsState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceMetadataTagsAsString().

Returns:

Enables or disables access to an instance's tags from the instance metadata. For more information, see View tags for your EC2 instances using instance metadata in the Amazon EC2 User Guide.

See Also:

• DefaultInstanceMetadataTagsState

instanceMetadataTagsAsString

public final String instanceMetadataTagsAsString()

Enables or disables access to an instance's tags from the instance metadata. For more information, see View tags for your EC2 instances using instance metadata in the Amazon EC2 User Guide.

If the service returns an enum value that is not available in the current SDK version, instanceMetadataTags will return DefaultInstanceMetadataTagsState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceMetadataTagsAsString().

Returns:

Enables or disables access to an instance's tags from the instance metadata. For more information, see View tags for your EC2 instances using instance metadata in the Amazon EC2 User Guide.

See Also:

• DefaultInstanceMetadataTagsState

dryRun

public final Boolean dryRun()

Checks whether you have the required permissions for the operation, 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 operation, 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.

httpTokensEnforced

public final DefaultHttpTokensEnforcedState httpTokensEnforced()

Specifies whether to enforce the requirement of IMDSv2 on an instance at the time of launch. When enforcement is enabled, the instance can't launch unless IMDSv2 (HttpTokens) is set to required. For more information, see Enforce IMDSv2 at the account level in the Amazon EC2 User Guide.

If the service returns an enum value that is not available in the current SDK version, httpTokensEnforced will return DefaultHttpTokensEnforcedState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from httpTokensEnforcedAsString().

Returns:

Specifies whether to enforce the requirement of IMDSv2 on an instance at the time of launch. When enforcement is enabled, the instance can't launch unless IMDSv2 (HttpTokens) is set to required. For more information, see Enforce IMDSv2 at the account level in the Amazon EC2 User Guide.

See Also:

• DefaultHttpTokensEnforcedState

httpTokensEnforcedAsString

public final String httpTokensEnforcedAsString()

Specifies whether to enforce the requirement of IMDSv2 on an instance at the time of launch. When enforcement is enabled, the instance can't launch unless IMDSv2 (HttpTokens) is set to required. For more information, see Enforce IMDSv2 at the account level in the Amazon EC2 User Guide.

If the service returns an enum value that is not available in the current SDK version, httpTokensEnforced will return DefaultHttpTokensEnforcedState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from httpTokensEnforcedAsString().

Returns:

Specifies whether to enforce the requirement of IMDSv2 on an instance at the time of launch. When enforcement is enabled, the instance can't launch unless IMDSv2 (HttpTokens) is set to required. For more information, see Enforce IMDSv2 at the account level in the Amazon EC2 User Guide.

See Also:

• DefaultHttpTokensEnforcedState

toBuilder

public ModifyInstanceMetadataDefaultsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ModifyInstanceMetadataDefaultsRequest.Builder,ModifyInstanceMetadataDefaultsRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static ModifyInstanceMetadataDefaultsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ModifyInstanceMetadataDefaultsRequest.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