Struct InstanceMetadataOptions

#[non_exhaustive]
pub struct InstanceMetadataOptions {
    pub state: Option<InstanceMetadataState>,
    pub http_tokens: Option<HttpTokens>,
    pub http_endpoint: Option<HttpEndpoint>,
    pub http_put_response_hop_limit: Option<i32>,
    pub http_protocol_ipv6: Option<HttpProtocolIpv6>,
}

The metadata options for the instance.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

state: Option<InstanceMetadataState>

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.

http_tokens: Option<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.

http_endpoint: Option<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.

http_put_response_hop_limit: Option<i32>

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

http_protocol_ipv6: Option<HttpProtocolIpv6>

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

Implementations

impl InstanceMetadataOptions

pub fn state(&self) -> Option<&InstanceMetadataState>

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.

pub fn http_tokens(&self) -> Option<&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.

pub fn http_endpoint(&self) -> Option<&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.

pub fn http_put_response_hop_limit(&self) -> Option<i32>

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

pub fn http_protocol_ipv6(&self) -> Option<&HttpProtocolIpv6>

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

impl InstanceMetadataOptions

pub fn builder() -> InstanceMetadataOptionsBuilder

Creates a new builder-style object to manufacture InstanceMetadataOptions.

Trait Implementations

impl Clone for InstanceMetadataOptions

fn clone(&self) -> InstanceMetadataOptions

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for InstanceMetadataOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for InstanceMetadataOptions

fn eq(&self, other: &InstanceMetadataOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for InstanceMetadataOptions