Struct aws_sdk_ec2::types::InstanceMetadataOptionsResponse

#[non_exhaustive]
pub struct InstanceMetadataOptionsResponse {
    pub state: Option<InstanceMetadataOptionsState>,
    pub http_tokens: Option<HttpTokensState>,
    pub http_put_response_hop_limit: Option<i32>,
    pub http_endpoint: Option<InstanceMetadataEndpointState>,
    pub http_protocol_ipv6: Option<InstanceMetadataProtocolState>,
    pub instance_metadata_tags: Option<InstanceMetadataTagsState>,
}

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<InstanceMetadataOptionsState>

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.

http_tokens: Option<HttpTokensState>

IMDSv2 uses token-backed sessions. Indicates whether the use of HTTP tokens is optional (in other words, indicates whether the use of IMDSv2 is optional) or required (in other words, indicates whether the use of IMDSv2 is 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

http_put_response_hop_limit: Option<i32>

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

http_endpoint: Option<InstanceMetadataEndpointState>

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_protocol_ipv6: Option<InstanceMetadataProtocolState>

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

instance_metadata_tags: Option<InstanceMetadataTagsState>

Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see Work with instance tags using the instance metadata.

Implementations

impl InstanceMetadataOptionsResponse

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

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.

pub fn http_tokens(&self) -> Option<&HttpTokensState>

IMDSv2 uses token-backed sessions. Indicates whether the use of HTTP tokens is optional (in other words, indicates whether the use of IMDSv2 is optional) or required (in other words, indicates whether the use of IMDSv2 is 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

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

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

pub fn http_endpoint(&self) -> Option<&InstanceMetadataEndpointState>

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_protocol_ipv6(&self) -> Option<&InstanceMetadataProtocolState>

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

pub fn instance_metadata_tags(&self) -> Option<&InstanceMetadataTagsState>

Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see Work with instance tags using the instance metadata.

impl InstanceMetadataOptionsResponse

pub fn builder() -> InstanceMetadataOptionsResponseBuilder

Creates a new builder-style object to manufacture InstanceMetadataOptionsResponse.

Trait Implementations

impl Clone for InstanceMetadataOptionsResponse

fn clone(&self) -> InstanceMetadataOptionsResponse

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InstanceMetadataOptionsResponse

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

Formats the value using the given formatter.

impl PartialEq<InstanceMetadataOptionsResponse> for InstanceMetadataOptionsResponse

fn eq(&self, other: &InstanceMetadataOptionsResponse) -> 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 InstanceMetadataOptionsResponse