software.amazon.awssdk.services.ec2.model

Class InstanceMetadataOptionsRequest

java.lang.Object

software.amazon.awssdk.services.ec2.model.InstanceMetadataOptionsRequest

All Implemented Interfaces:

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

@Generated(value="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 and Description
static interface	InstanceMetadataOptionsRequest.Builder

Method Summary

Modifier and Type	Method and 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() The state of token usage for your instance metadata requests.
String	httpTokensAsString() The state of token usage for your instance metadata requests.
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.
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()

The state of token usage for your instance metadata requests.

If the state is optional, you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.

If the state is required, you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 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:

The state of token usage for your instance metadata requests.

If the state is optional, you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.

If the state is required, you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.

Default: optional

See Also:

HttpTokensState

httpTokensAsString

public final String httpTokensAsString()

The state of token usage for your instance metadata requests.

If the state is optional, you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.

If the state is required, you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 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:

The state of token usage for your instance metadata requests.

If the state is optional, you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.

If the state is required, you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 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()

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

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

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.

Default: disabled

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.

Default: disabled

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.

Default: disabled

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.

Default: disabled

See Also:

InstanceMetadataTagsState

toBuilder

public InstanceMetadataOptionsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<InstanceMetadataOptionsRequest.Builder,InstanceMetadataOptionsRequest>

builder

public static InstanceMetadataOptionsRequest.Builder builder()

serializableBuilderClass

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