software.amazon.awssdk.services.ec2.model

Interface LaunchTemplateInstanceMetadataOptions.Builder

All Superinterfaces:

Buildable, CopyableBuilder<LaunchTemplateInstanceMetadataOptions.Builder,LaunchTemplateInstanceMetadataOptions>, SdkBuilder<LaunchTemplateInstanceMetadataOptions.Builder,LaunchTemplateInstanceMetadataOptions>, SdkPojo

Enclosing class:

LaunchTemplateInstanceMetadataOptions

public static interface LaunchTemplateInstanceMetadataOptions.Builder
extends SdkPojo, CopyableBuilder<LaunchTemplateInstanceMetadataOptions.Builder,LaunchTemplateInstanceMetadataOptions>

Method Summary

Modifier and Type	Method and Description
LaunchTemplateInstanceMetadataOptions.Builder	httpEndpoint(LaunchTemplateInstanceMetadataEndpointState httpEndpoint) Enables or disables the HTTP metadata endpoint on your instances.
LaunchTemplateInstanceMetadataOptions.Builder	httpEndpoint(String httpEndpoint) Enables or disables the HTTP metadata endpoint on your instances.
LaunchTemplateInstanceMetadataOptions.Builder	httpProtocolIpv6(LaunchTemplateInstanceMetadataProtocolIpv6 httpProtocolIpv6) Enables or disables the IPv6 endpoint for the instance metadata service.
LaunchTemplateInstanceMetadataOptions.Builder	httpProtocolIpv6(String httpProtocolIpv6) Enables or disables the IPv6 endpoint for the instance metadata service.
LaunchTemplateInstanceMetadataOptions.Builder	httpPutResponseHopLimit(Integer httpPutResponseHopLimit) The desired HTTP PUT response hop limit for instance metadata requests.
LaunchTemplateInstanceMetadataOptions.Builder	httpTokens(LaunchTemplateHttpTokensState httpTokens) Indicates whether IMDSv2 is optional or required.
LaunchTemplateInstanceMetadataOptions.Builder	httpTokens(String httpTokens) Indicates whether IMDSv2 is optional or required.
LaunchTemplateInstanceMetadataOptions.Builder	instanceMetadataTags(LaunchTemplateInstanceMetadataTagsState instanceMetadataTags) Set to enabled to allow access to instance tags from the instance metadata.
LaunchTemplateInstanceMetadataOptions.Builder	instanceMetadataTags(String instanceMetadataTags) Set to enabled to allow access to instance tags from the instance metadata.
LaunchTemplateInstanceMetadataOptions.Builder	state(LaunchTemplateInstanceMetadataOptionsState state) The state of the metadata option changes.
LaunchTemplateInstanceMetadataOptions.Builder	state(String state) The state of the metadata option changes.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

state

LaunchTemplateInstanceMetadataOptions.Builder state(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LaunchTemplateInstanceMetadataOptionsState, LaunchTemplateInstanceMetadataOptionsState

state

LaunchTemplateInstanceMetadataOptions.Builder state(LaunchTemplateInstanceMetadataOptionsState 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LaunchTemplateInstanceMetadataOptionsState, LaunchTemplateInstanceMetadataOptionsState

httpTokens

LaunchTemplateInstanceMetadataOptions.Builder httpTokens(String httpTokens)

Indicates whether IMDSv2 is optional or 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

Parameters:

httpTokens - Indicates whether IMDSv2 is optional or 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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LaunchTemplateHttpTokensState, LaunchTemplateHttpTokensState

httpTokens

LaunchTemplateInstanceMetadataOptions.Builder httpTokens(LaunchTemplateHttpTokensState httpTokens)

Indicates whether IMDSv2 is optional or 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

Parameters:

httpTokens - Indicates whether IMDSv2 is optional or 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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LaunchTemplateHttpTokensState, LaunchTemplateHttpTokensState

httpPutResponseHopLimit

LaunchTemplateInstanceMetadataOptions.Builder httpPutResponseHopLimit(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

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

httpEndpoint

LaunchTemplateInstanceMetadataOptions.Builder httpEndpoint(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LaunchTemplateInstanceMetadataEndpointState, LaunchTemplateInstanceMetadataEndpointState

httpEndpoint

LaunchTemplateInstanceMetadataOptions.Builder httpEndpoint(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LaunchTemplateInstanceMetadataEndpointState, LaunchTemplateInstanceMetadataEndpointState

httpProtocolIpv6

LaunchTemplateInstanceMetadataOptions.Builder httpProtocolIpv6(String httpProtocolIpv6)

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

Default: disabled

Parameters:

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

Default: disabled

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LaunchTemplateInstanceMetadataProtocolIpv6, LaunchTemplateInstanceMetadataProtocolIpv6

httpProtocolIpv6

LaunchTemplateInstanceMetadataOptions.Builder httpProtocolIpv6(LaunchTemplateInstanceMetadataProtocolIpv6 httpProtocolIpv6)

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

Default: disabled

Parameters:

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

Default: disabled

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LaunchTemplateInstanceMetadataProtocolIpv6, LaunchTemplateInstanceMetadataProtocolIpv6

instanceMetadataTags

LaunchTemplateInstanceMetadataOptions.Builder instanceMetadataTags(String 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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LaunchTemplateInstanceMetadataTagsState, LaunchTemplateInstanceMetadataTagsState

instanceMetadataTags

LaunchTemplateInstanceMetadataOptions.Builder instanceMetadataTags(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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LaunchTemplateInstanceMetadataTagsState, LaunchTemplateInstanceMetadataTagsState