software.amazon.awssdk.services.lightsail.model

Class InstanceMetadataOptions

java.lang.Object

software.amazon.awssdk.services.lightsail.model.InstanceMetadataOptions

All Implemented Interfaces:

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

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

The metadata options for the instance.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	InstanceMetadataOptions.Builder

Method Summary

Modifier and Type	Method and Description
static InstanceMetadataOptions.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
HttpEndpoint	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.
HttpProtocolIpv6	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.
HttpTokens	httpTokens() The state of token usage for your instance metadata requests.
String	httpTokensAsString() The state of token usage for your instance metadata requests.
List<SdkField<?>>	sdkFields()
static Class<? extends InstanceMetadataOptions.Builder>	serializableBuilderClass()
InstanceMetadataState	state() The state of the metadata option changes.
String	stateAsString() The state of the metadata option changes.
InstanceMetadataOptions.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 InstanceMetadataState state()

The state of the metadata option changes.

The following states are possible:

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

• applied - The metadata options have been successfully applied to the instance.

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

Returns:

The state of the metadata option changes.

The following states are possible:

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

• applied - The metadata options have been successfully applied to the instance.

See Also:

InstanceMetadataState

stateAsString

public final String stateAsString()

The state of the metadata option changes.

The following states are possible:

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

• applied - The metadata options have been successfully applied to the instance.

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

Returns:

The state of the metadata option changes.

The following states are possible:

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

• applied - The metadata options have been successfully applied to the instance.

See Also:

InstanceMetadataState

httpTokens

public final HttpTokens httpTokens()

The state of token usage for your instance metadata requests.

If the state is optional, you can choose whether to retrieve instance metadata with 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 by 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 all instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The version 1.0 credentials are not available.

Not all instance blueprints in Lightsail support version 2.0 credentials. Use the MetadataNoToken instance metric to track the number of calls to the instance metadata service that are using version 1.0 credentials. For more information, see Viewing instance metrics in Amazon Lightsail in the Amazon Lightsail Developer Guide.

If the service returns an enum value that is not available in the current SDK version, httpTokens will return HttpTokens.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 whether to retrieve instance metadata with 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 by 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 all instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The version 1.0 credentials are not available.

Not all instance blueprints in Lightsail support version 2.0 credentials. Use the MetadataNoToken instance metric to track the number of calls to the instance metadata service that are using version 1.0 credentials. For more information, see Viewing instance metrics in Amazon Lightsail in the Amazon Lightsail Developer Guide.

See Also:

HttpTokens

httpTokensAsString

public final String httpTokensAsString()

The state of token usage for your instance metadata requests.

If the state is optional, you can choose whether to retrieve instance metadata with 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 by 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 all instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The version 1.0 credentials are not available.

Not all instance blueprints in Lightsail support version 2.0 credentials. Use the MetadataNoToken instance metric to track the number of calls to the instance metadata service that are using version 1.0 credentials. For more information, see Viewing instance metrics in Amazon Lightsail in the Amazon Lightsail Developer Guide.

If the service returns an enum value that is not available in the current SDK version, httpTokens will return HttpTokens.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 whether to retrieve instance metadata with 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 by 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 all instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The version 1.0 credentials are not available.

Not all instance blueprints in Lightsail support version 2.0 credentials. Use the MetadataNoToken instance metric to track the number of calls to the instance metadata service that are using version 1.0 credentials. For more information, see Viewing instance metrics in Amazon Lightsail in the Amazon Lightsail Developer Guide.

See Also:

HttpTokens

httpEndpoint

public final HttpEndpoint 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 HttpEndpoint.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:

HttpEndpoint

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

HttpEndpoint

httpPutResponseHopLimit

public final Integer httpPutResponseHopLimit()

The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the instance metadata requests can travel farther.

Returns:

The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the instance metadata requests can travel farther.

httpProtocolIpv6

public final HttpProtocolIpv6 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 HttpProtocolIpv6.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:

HttpProtocolIpv6

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

HttpProtocolIpv6

toBuilder

public InstanceMetadataOptions.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<InstanceMetadataOptions.Builder,InstanceMetadataOptions>

builder

public static InstanceMetadataOptions.Builder builder()

serializableBuilderClass

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