Struct aws_sdk_lightsail::types::builders::InstanceMetadataOptionsBuilder

#[non_exhaustive]
pub struct InstanceMetadataOptionsBuilder { /* private fields */ }

A builder for InstanceMetadataOptions.

Implementations

impl InstanceMetadataOptionsBuilder

pub fn state(self, input: InstanceMetadataState) -> Self

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 set_state(self, input: Option<InstanceMetadataState>) -> Self

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 get_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, input: HttpTokens) -> Self

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 set_http_tokens(self, input: Option<HttpTokens>) -> Self

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 get_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, input: HttpEndpoint) -> Self

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 set_http_endpoint(self, input: Option<HttpEndpoint>) -> Self

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 get_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, input: i32) -> Self

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 set_http_put_response_hop_limit(self, input: Option<i32>) -> Self

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 get_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, input: HttpProtocolIpv6) -> Self

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

pub fn set_http_protocol_ipv6(self, input: Option<HttpProtocolIpv6>) -> Self

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

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

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

pub fn build(self) -> InstanceMetadataOptions

Consumes the builder and constructs a InstanceMetadataOptions.

Trait Implementations

impl Clone for InstanceMetadataOptionsBuilder

fn clone(&self) -> InstanceMetadataOptionsBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InstanceMetadataOptionsBuilder

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

Formats the value using the given formatter.

impl Default for InstanceMetadataOptionsBuilder

fn default() -> InstanceMetadataOptionsBuilder

Returns the “default value” for a type.

impl PartialEq for InstanceMetadataOptionsBuilder

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for InstanceMetadataOptionsBuilder