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

Class LaunchTemplateInstanceMetadataOptionsRequest

java.lang.Object

software.amazon.awssdk.services.ec2.model.LaunchTemplateInstanceMetadataOptionsRequest

All Implemented Interfaces:

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

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

The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon Elastic Compute Cloud User Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	LaunchTemplateInstanceMetadataOptionsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static LaunchTemplateInstanceMetadataOptionsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
LaunchTemplateInstanceMetadataEndpointState	httpEndpoint()	Enables or disables the HTTP metadata endpoint on your instances.
String	httpEndpointAsString()	Enables or disables the HTTP metadata endpoint on your instances.
LaunchTemplateInstanceMetadataProtocolIpv6	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.
LaunchTemplateHttpTokensState	httpTokens()	IMDSv2 uses token-backed sessions.
String	httpTokensAsString()	IMDSv2 uses token-backed sessions.
LaunchTemplateInstanceMetadataTagsState	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 LaunchTemplateInstanceMetadataOptionsRequest.Builder>	serializableBuilderClass()
LaunchTemplateInstanceMetadataOptionsRequest.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 LaunchTemplateHttpTokensState httpTokens()

IMDSv2 uses token-backed sessions. Set the use of HTTP tokens to optional (in other words, set the use of IMDSv2 to optional) or required (in other words, set the use of IMDSv2 to 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 LaunchTemplateHttpTokensState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from httpTokensAsString().

Returns:

IMDSv2 uses token-backed sessions. Set the use of HTTP tokens to optional (in other words, set the use of IMDSv2 to optional) or required (in other words, set the use of IMDSv2 to 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:

LaunchTemplateHttpTokensState

httpTokensAsString

public final String httpTokensAsString()

IMDSv2 uses token-backed sessions. Set the use of HTTP tokens to optional (in other words, set the use of IMDSv2 to optional) or required (in other words, set the use of IMDSv2 to 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 LaunchTemplateHttpTokensState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from httpTokensAsString().

Returns:

IMDSv2 uses token-backed sessions. Set the use of HTTP tokens to optional (in other words, set the use of IMDSv2 to optional) or required (in other words, set the use of IMDSv2 to 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:

LaunchTemplateHttpTokensState

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

Enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled.

If you specify a value of disabled, you will not be able to access your instance metadata.

If the service returns an enum value that is not available in the current SDK version, httpEndpoint will return LaunchTemplateInstanceMetadataEndpointState.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 the parameter is not specified, the default state is enabled.

If you specify a value of disabled, you will not be able to access your instance metadata.

See Also:

LaunchTemplateInstanceMetadataEndpointState

httpEndpointAsString

public final String httpEndpointAsString()

Enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled.

If you specify a value of disabled, you will not be able to access your instance metadata.

If the service returns an enum value that is not available in the current SDK version, httpEndpoint will return LaunchTemplateInstanceMetadataEndpointState.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 the parameter is not specified, the default state is enabled.

If you specify a value of disabled, you will not be able to access your instance metadata.

See Also:

LaunchTemplateInstanceMetadataEndpointState

httpProtocolIpv6

public final LaunchTemplateInstanceMetadataProtocolIpv6 httpProtocolIpv6()

Enables or disables the IPv6 endpoint for the instance metadata service.

Default: disabled

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

Default: disabled

See Also:

LaunchTemplateInstanceMetadataProtocolIpv6

httpProtocolIpv6AsString

public final String httpProtocolIpv6AsString()

Enables or disables the IPv6 endpoint for the instance metadata service.

Default: disabled

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

Default: disabled

See Also:

LaunchTemplateInstanceMetadataProtocolIpv6

instanceMetadataTags

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

LaunchTemplateInstanceMetadataTagsState

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

LaunchTemplateInstanceMetadataTagsState

toBuilder

public LaunchTemplateInstanceMetadataOptionsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<LaunchTemplateInstanceMetadataOptionsRequest.Builder,LaunchTemplateInstanceMetadataOptionsRequest>

builder

public static LaunchTemplateInstanceMetadataOptionsRequest.Builder builder()

serializableBuilderClass

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