InstanceMetadataOptions

import type { InstanceMetadataOptions } from "https://aws-api.deno.dev/v0.4/services/lightsail.ts?docs=full";

The metadata options for the instance.

interface InstanceMetadataOptions {

httpEndpoint?: HttpEndpoint | null;

httpProtocolIpv6?: HttpProtocolIpv6 | null;

httpPutResponseHopLimit?: number | null;

httpTokens?: HttpTokens | null;

state?: InstanceMetadataState | null;

}

§Properties

httpEndpoint?: HttpEndpoint | null

[src]

Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.

If the value is disabled, you cannot access your instance metadata.

httpProtocolIpv6?: HttpProtocolIpv6 | null

[src]

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

httpPutResponseHopLimit?: number | null

[src]

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

httpTokens?: HttpTokens | null

[src]

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.

! IMPORTANT: ! 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.

state?: InstanceMetadataState | null

[src]

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.