#[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>,
}
Expand description
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)§
This struct is marked as non-exhaustive
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
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§
Source§impl LaunchTemplateInstanceMetadataOptions
impl LaunchTemplateInstanceMetadataOptions
Sourcepub fn state(&self) -> Option<&LaunchTemplateInstanceMetadataOptionsState>
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.
Sourcepub fn http_tokens(&self) -> Option<&LaunchTemplateHttpTokensState>
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.
Sourcepub fn http_put_response_hop_limit(&self) -> Option<i32>
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
Sourcepub fn http_endpoint(
&self,
) -> Option<&LaunchTemplateInstanceMetadataEndpointState>
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.
Sourcepub fn http_protocol_ipv6(
&self,
) -> Option<&LaunchTemplateInstanceMetadataProtocolIpv6>
pub fn http_protocol_ipv6( &self, ) -> Option<&LaunchTemplateInstanceMetadataProtocolIpv6>
Enables or disables the IPv6 endpoint for the instance metadata service.
Default: disabled
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
Source§impl LaunchTemplateInstanceMetadataOptions
impl LaunchTemplateInstanceMetadataOptions
Sourcepub fn builder() -> LaunchTemplateInstanceMetadataOptionsBuilder
pub fn builder() -> LaunchTemplateInstanceMetadataOptionsBuilder
Creates a new builder-style object to manufacture LaunchTemplateInstanceMetadataOptions
.
Trait Implementations§
Source§impl Clone for LaunchTemplateInstanceMetadataOptions
impl Clone for LaunchTemplateInstanceMetadataOptions
Source§fn clone(&self) -> LaunchTemplateInstanceMetadataOptions
fn clone(&self) -> LaunchTemplateInstanceMetadataOptions
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl PartialEq for LaunchTemplateInstanceMetadataOptions
impl PartialEq for LaunchTemplateInstanceMetadataOptions
Source§fn eq(&self, other: &LaunchTemplateInstanceMetadataOptions) -> bool
fn eq(&self, other: &LaunchTemplateInstanceMetadataOptions) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for LaunchTemplateInstanceMetadataOptions
Auto Trait Implementations§
impl Freeze for LaunchTemplateInstanceMetadataOptions
impl RefUnwindSafe for LaunchTemplateInstanceMetadataOptions
impl Send for LaunchTemplateInstanceMetadataOptions
impl Sync for LaunchTemplateInstanceMetadataOptions
impl Unpin for LaunchTemplateInstanceMetadataOptions
impl UnwindSafe for LaunchTemplateInstanceMetadataOptions
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);