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 Use instance metadata to manage your EC2 instance in the Amazon EC2 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()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final LaunchTemplateInstanceMetadataEndpointState	httpEndpoint()	Enables or disables the HTTP metadata endpoint on your instances.
final String	httpEndpointAsString()	Enables or disables the HTTP metadata endpoint on your instances.
final LaunchTemplateInstanceMetadataProtocolIpv6	httpProtocolIpv6()	Enables or disables the IPv6 endpoint for the instance metadata service.
final String	httpProtocolIpv6AsString()	Enables or disables the IPv6 endpoint for the instance metadata service.
final Integer	httpPutResponseHopLimit()	The desired HTTP PUT response hop limit for instance metadata requests.
final LaunchTemplateHttpTokensState	httpTokens()	Indicates whether IMDSv2 is required.
final String	httpTokensAsString()	Indicates whether IMDSv2 is required.
final LaunchTemplateInstanceMetadataTagsState	instanceMetadataTags()	Set to enabled to allow access to instance tags from the instance metadata.
final String	instanceMetadataTagsAsString()	Set to enabled to allow access to instance tags from the instance metadata.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends LaunchTemplateInstanceMetadataOptionsRequest.Builder>	serializableBuilderClass()
LaunchTemplateInstanceMetadataOptionsRequest.Builder	toBuilder()
final 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 Details

httpTokens

public final LaunchTemplateHttpTokensState httpTokens()

Indicates whether IMDSv2 is required.

• optional - IMDSv2 is optional. You can choose whether to send a session token in your instance metadata retrieval requests. If you retrieve IAM role credentials without a session token, you receive the IMDSv1 role credentials. If you retrieve IAM role credentials using a valid session token, you receive the IMDSv2 role credentials.

• required - IMDSv2 is required. You must send a session token in your instance metadata retrieval requests. With this option, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.

Default: If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0, the default is required.

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:

Indicates whether IMDSv2 is required.

• optional - IMDSv2 is optional. You can choose whether to send a session token in your instance metadata retrieval requests. If you retrieve IAM role credentials without a session token, you receive the IMDSv1 role credentials. If you retrieve IAM role credentials using a valid session token, you receive the IMDSv2 role credentials.

• required - IMDSv2 is required. You must send a session token in your instance metadata retrieval requests. With this option, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.

Default: If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0, the default is required.

See Also:

• LaunchTemplateHttpTokensState

httpTokensAsString

public final String httpTokensAsString()

Indicates whether IMDSv2 is required.

• optional - IMDSv2 is optional. You can choose whether to send a session token in your instance metadata retrieval requests. If you retrieve IAM role credentials without a session token, you receive the IMDSv1 role credentials. If you retrieve IAM role credentials using a valid session token, you receive the IMDSv2 role credentials.

• required - IMDSv2 is required. You must send a session token in your instance metadata retrieval requests. With this option, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.

Default: If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0, the default is required.

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:

Indicates whether IMDSv2 is required.

• optional - IMDSv2 is optional. You can choose whether to send a session token in your instance metadata retrieval requests. If you retrieve IAM role credentials without a session token, you receive the IMDSv1 role credentials. If you retrieve IAM role credentials using a valid session token, you receive the IMDSv2 role credentials.

• required - IMDSv2 is required. You must send a session token in your instance metadata retrieval requests. With this option, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.

Default: If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0, the default is required.

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 View tags for your EC2 instances using 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 View tags for your EC2 instances using 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 View tags for your EC2 instances using 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 View tags for your EC2 instances using 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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo