Struct LaunchTemplateInstanceMetadataOptions

#[non_exhaustive]
pub struct LaunchTemplateInstanceMetadataOptions {
    pub state: Option<LaunchTemplateInstanceMetadataOptionsState>,
    pub http_tokens: Option<LaunchTemplateHttpTokensState>,
    pub http_put_response_hop_limit: Option<i32>,
    pub http_endpoint: Option<LaunchTemplateInstanceMetadataEndpointState>,
    pub http_protocol_ipv6: Option<LaunchTemplateInstanceMetadataProtocolIpv6>,
    pub instance_metadata_tags: Option<LaunchTemplateInstanceMetadataTagsState>,
}

The metadata options for the instance. For more information, see Use instance metadata to manage your EC2 instance in the Amazon EC2 User Guide.

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

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

Indicates whether IMDSv2 is required.

• optional - IMDSv2 is optional. You can choose whether to send a session token in your instance metadata retrieval requests. If you retrieve IAM role credentials without a session token, you receive the IMDSv1 role credentials. If you retrieve IAM role credentials using a valid session token, you receive the IMDSv2 role credentials.

• required - IMDSv2 is required. You must send a session token in your instance metadata retrieval requests. With this option, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.

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

Enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled.

If you specify a value of disabled, you will not be able to access your instance metadata.

http_protocol_ipv6: Option<LaunchTemplateInstanceMetadataProtocolIpv6>

Enables or disables the IPv6 endpoint for the instance metadata service.

Default: disabled

instance_metadata_tags: Option<LaunchTemplateInstanceMetadataTagsState>

Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see View tags for your EC2 instances using instance metadata.

Default: disabled

Implementations

impl LaunchTemplateInstanceMetadataOptions

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

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<&LaunchTemplateHttpTokensState>

Indicates whether IMDSv2 is required.

• optional - IMDSv2 is optional. You can choose whether to send a session token in your instance metadata retrieval requests. If you retrieve IAM role credentials without a session token, you receive the IMDSv1 role credentials. If you retrieve IAM role credentials using a valid session token, you receive the IMDSv2 role credentials.

• required - IMDSv2 is required. You must send a session token in your instance metadata retrieval requests. With this option, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.

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<&LaunchTemplateInstanceMetadataEndpointState>

Enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled.

If you specify a value of disabled, you will not be able to access your instance metadata.

pub fn http_protocol_ipv6( &self, ) -> Option<&LaunchTemplateInstanceMetadataProtocolIpv6>

Enables or disables the IPv6 endpoint for the instance metadata service.

Default: disabled

pub fn instance_metadata_tags( &self, ) -> Option<&LaunchTemplateInstanceMetadataTagsState>

Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see View tags for your EC2 instances using instance metadata.

Default: disabled

impl LaunchTemplateInstanceMetadataOptions

pub fn builder() -> LaunchTemplateInstanceMetadataOptionsBuilder

Creates a new builder-style object to manufacture LaunchTemplateInstanceMetadataOptions.

Trait Implementations

impl Clone for LaunchTemplateInstanceMetadataOptions

fn clone(&self) -> LaunchTemplateInstanceMetadataOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LaunchTemplateInstanceMetadataOptions

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

Formats the value using the given formatter.

impl PartialEq for LaunchTemplateInstanceMetadataOptions

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

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

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 LaunchTemplateInstanceMetadataOptions