software.amazon.awssdk.services.lightsail.model

Interface InstanceMetadataOptions.Builder

All Superinterfaces:

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

Enclosing class:

InstanceMetadataOptions

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

Method Summary

Modifier and Type	Method and Description
InstanceMetadataOptions.Builder	httpEndpoint(HttpEndpoint httpEndpoint) Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.
InstanceMetadataOptions.Builder	httpEndpoint(String httpEndpoint) Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.
InstanceMetadataOptions.Builder	httpProtocolIpv6(HttpProtocolIpv6 httpProtocolIpv6) Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.
InstanceMetadataOptions.Builder	httpProtocolIpv6(String httpProtocolIpv6) Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.
InstanceMetadataOptions.Builder	httpPutResponseHopLimit(Integer httpPutResponseHopLimit) The desired HTTP PUT response hop limit for instance metadata requests.
InstanceMetadataOptions.Builder	httpTokens(HttpTokens httpTokens) The state of token usage for your instance metadata requests.
InstanceMetadataOptions.Builder	httpTokens(String httpTokens) The state of token usage for your instance metadata requests.
InstanceMetadataOptions.Builder	state(InstanceMetadataState state) The state of the metadata option changes.
InstanceMetadataOptions.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

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

Parameters:

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.

Returns:

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

See Also:

InstanceMetadataState, InstanceMetadataState

state

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

Parameters:

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.

Returns:

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

See Also:

InstanceMetadataState, InstanceMetadataState

httpTokens

InstanceMetadataOptions.Builder httpTokens(String 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.

Parameters:

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.

Returns:

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

See Also:

HttpTokens, HttpTokens

httpTokens

InstanceMetadataOptions.Builder httpTokens(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.

Parameters:

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.

Returns:

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

See Also:

HttpTokens, HttpTokens

httpEndpoint

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

Parameters:

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.

Returns:

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

See Also:

HttpEndpoint, HttpEndpoint

httpEndpoint

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

Parameters:

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.

Returns:

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

See Also:

HttpEndpoint, HttpEndpoint

httpPutResponseHopLimit

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

Parameters:

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:

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

httpProtocolIpv6

InstanceMetadataOptions.Builder httpProtocolIpv6(String httpProtocolIpv6)

Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.

Parameters:

httpProtocolIpv6 - Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.

Returns:

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

See Also:

HttpProtocolIpv6, HttpProtocolIpv6

httpProtocolIpv6

InstanceMetadataOptions.Builder httpProtocolIpv6(HttpProtocolIpv6 httpProtocolIpv6)

Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.

Parameters:

httpProtocolIpv6 - Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.

Returns:

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

See Also:

HttpProtocolIpv6, HttpProtocolIpv6