software.amazon.awssdk.services.ec2.model

Class InstanceMetadataOptionsResponse

java.lang.Object

software.amazon.awssdk.services.ec2.model.InstanceMetadataOptionsResponse

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<InstanceMetadataOptionsResponse.Builder,InstanceMetadataOptionsResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class InstanceMetadataOptionsResponse
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<InstanceMetadataOptionsResponse.Builder,InstanceMetadataOptionsResponse>

The metadata options for the instance.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	InstanceMetadataOptionsResponse.Builder

Method Summary

Modifier and Type	Method and Description
static InstanceMetadataOptionsResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
InstanceMetadataEndpointState	httpEndpoint() Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.
String	httpEndpointAsString() Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.
InstanceMetadataProtocolState	httpProtocolIpv6() Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.
String	httpProtocolIpv6AsString() Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.
Integer	httpPutResponseHopLimit() The desired HTTP PUT response hop limit for instance metadata requests.
HttpTokensState	httpTokens() IMDSv2 uses token-backed sessions.
String	httpTokensAsString() IMDSv2 uses token-backed sessions.
InstanceMetadataTagsState	instanceMetadataTags() Indicates whether access to instance tags from the instance metadata is enabled or disabled.
String	instanceMetadataTagsAsString() Indicates whether access to instance tags from the instance metadata is enabled or disabled.
List<SdkField<?>>	sdkFields()
static Class<? extends InstanceMetadataOptionsResponse.Builder>	serializableBuilderClass()
InstanceMetadataOptionsState	state() The state of the metadata option changes.
String	stateAsString() The state of the metadata option changes.
InstanceMetadataOptionsResponse.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

state

public final InstanceMetadataOptionsState state()

The state of the metadata option changes.

pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.

applied - The metadata options have been successfully applied on the instance.

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

Returns:

The state of the metadata option changes.

pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.

applied - The metadata options have been successfully applied on the instance.

See Also:

InstanceMetadataOptionsState

stateAsString

public final String stateAsString()

The state of the metadata option changes.

pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.

applied - The metadata options have been successfully applied on the instance.

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

Returns:

The state of the metadata option changes.

pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.

applied - The metadata options have been successfully applied on the instance.

See Also:

InstanceMetadataOptionsState

httpTokens

public final HttpTokensState httpTokens()

IMDSv2 uses token-backed sessions. Indicates whether the use of HTTP tokens is optional (in other words, indicates whether the use of IMDSv2 is optional) or required (in other words, indicates whether the use of IMDSv2 is required).

• optional - When IMDSv2 is optional, you can choose to retrieve instance metadata with or without a session token in your request. If you retrieve the IAM role credentials without a token, the IMDSv1 role credentials are returned. If you retrieve the IAM role credentials using a valid session token, the IMDSv2 role credentials are returned.

• required - When IMDSv2 is required, you must send a session token with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.

Default: optional

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:

IMDSv2 uses token-backed sessions. Indicates whether the use of HTTP tokens is optional (in other words, indicates whether the use of IMDSv2 is optional) or required (in other words, indicates whether the use of IMDSv2 is required).

• optional - When IMDSv2 is optional, you can choose to retrieve instance metadata with or without a session token in your request. If you retrieve the IAM role credentials without a token, the IMDSv1 role credentials are returned. If you retrieve the IAM role credentials using a valid session token, the IMDSv2 role credentials are returned.

• required - When IMDSv2 is required, you must send a session token with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.

Default: optional

See Also:

HttpTokensState

httpTokensAsString

public final String httpTokensAsString()

IMDSv2 uses token-backed sessions. Indicates whether the use of HTTP tokens is optional (in other words, indicates whether the use of IMDSv2 is optional) or required (in other words, indicates whether the use of IMDSv2 is required).

• optional - When IMDSv2 is optional, you can choose to retrieve instance metadata with or without a session token in your request. If you retrieve the IAM role credentials without a token, the IMDSv1 role credentials are returned. If you retrieve the IAM role credentials using a valid session token, the IMDSv2 role credentials are returned.

• required - When IMDSv2 is required, you must send a session token with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.

Default: optional

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:

IMDSv2 uses token-backed sessions. Indicates whether the use of HTTP tokens is optional (in other words, indicates whether the use of IMDSv2 is optional) or required (in other words, indicates whether the use of IMDSv2 is required).

• optional - When IMDSv2 is optional, you can choose to retrieve instance metadata with or without a session token in your request. If you retrieve the IAM role credentials without a token, the IMDSv1 role credentials are returned. If you retrieve the IAM role credentials using a valid session token, the IMDSv2 role credentials are returned.

• required - When IMDSv2 is required, you must send a session token with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.

Default: optional

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()

Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.

If the value is 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:

Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.

If the value is disabled, you cannot access your instance metadata.

See Also:

InstanceMetadataEndpointState

httpEndpointAsString

public final String httpEndpointAsString()

Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.

If the value is 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:

Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.

If the value is disabled, you cannot access your instance metadata.

See Also:

InstanceMetadataEndpointState

httpProtocolIpv6

public final InstanceMetadataProtocolState httpProtocolIpv6()

Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.

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:

Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.

See Also:

InstanceMetadataProtocolState

httpProtocolIpv6AsString

public final String httpProtocolIpv6AsString()

Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.

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:

Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.

See Also:

InstanceMetadataProtocolState

instanceMetadataTags

public final InstanceMetadataTagsState instanceMetadataTags()

Indicates whether access to instance tags from the instance metadata is enabled or disabled. 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:

Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see Work with instance tags using the instance metadata.

See Also:

InstanceMetadataTagsState

instanceMetadataTagsAsString

public final String instanceMetadataTagsAsString()

Indicates whether access to instance tags from the instance metadata is enabled or disabled. 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:

Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see Work with instance tags using the instance metadata.

See Also:

InstanceMetadataTagsState

toBuilder

public InstanceMetadataOptionsResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<InstanceMetadataOptionsResponse.Builder,InstanceMetadataOptionsResponse>

builder

public static InstanceMetadataOptionsResponse.Builder builder()

serializableBuilderClass

public static Class<? extends InstanceMetadataOptionsResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo