#[non_exhaustive]pub struct InstanceMetadataOptionsRequest {
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>,
}
Expand description
The metadata options for the instance.
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.http_tokens: Option<HttpTokensState>
Indicates whether IMDSv2 is required.
-
optional
- IMDSv2 is optional, which means that you can use either IMDSv2 or IMDSv1. -
required
- IMDSv2 is required, which means that IMDSv1 is disabled, and you must use IMDSv2.
Default:
-
If the value of
ImdsSupport
for the Amazon Machine Image (AMI) for your instance isv2.0
and the account level default is set tono-preference
, the default isrequired
. -
If the value of
ImdsSupport
for the Amazon Machine Image (AMI) for your instance isv2.0
, but the account level default is set toV1 or V2
, the default isoptional
.
The default value can also be affected by other combinations of parameters. For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.
http_put_response_hop_limit: Option<i32>
The maximum number of hops that the metadata token can travel.
Possible values: Integers from 1 to 64
http_endpoint: Option<InstanceMetadataEndpointState>
Enables or disables the HTTP metadata endpoint on your instances.
If you specify a value of disabled
, you cannot access your instance metadata.
Default: enabled
http_protocol_ipv6: Option<InstanceMetadataProtocolState>
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 Work with instance tags using the instance metadata.
Default: disabled
Implementations§
Source§impl InstanceMetadataOptionsRequest
impl InstanceMetadataOptionsRequest
Sourcepub fn http_tokens(&self) -> Option<&HttpTokensState>
pub fn http_tokens(&self) -> Option<&HttpTokensState>
Indicates whether IMDSv2 is required.
-
optional
- IMDSv2 is optional, which means that you can use either IMDSv2 or IMDSv1. -
required
- IMDSv2 is required, which means that IMDSv1 is disabled, and you must use IMDSv2.
Default:
-
If the value of
ImdsSupport
for the Amazon Machine Image (AMI) for your instance isv2.0
and the account level default is set tono-preference
, the default isrequired
. -
If the value of
ImdsSupport
for the Amazon Machine Image (AMI) for your instance isv2.0
, but the account level default is set toV1 or V2
, the default isoptional
.
The default value can also be affected by other combinations of parameters. For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.
Sourcepub fn http_put_response_hop_limit(&self) -> Option<i32>
pub fn http_put_response_hop_limit(&self) -> Option<i32>
The maximum number of hops that the metadata token can travel.
Possible values: Integers from 1 to 64
Sourcepub fn http_endpoint(&self) -> Option<&InstanceMetadataEndpointState>
pub fn http_endpoint(&self) -> Option<&InstanceMetadataEndpointState>
Enables or disables the HTTP metadata endpoint on your instances.
If you specify a value of disabled
, you cannot access your instance metadata.
Default: enabled
Sourcepub fn http_protocol_ipv6(&self) -> Option<&InstanceMetadataProtocolState>
pub fn http_protocol_ipv6(&self) -> Option<&InstanceMetadataProtocolState>
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 Work with instance tags using the instance metadata.
Default: disabled
Source§impl InstanceMetadataOptionsRequest
impl InstanceMetadataOptionsRequest
Sourcepub fn builder() -> InstanceMetadataOptionsRequestBuilder
pub fn builder() -> InstanceMetadataOptionsRequestBuilder
Creates a new builder-style object to manufacture InstanceMetadataOptionsRequest
.
Trait Implementations§
Source§impl Clone for InstanceMetadataOptionsRequest
impl Clone for InstanceMetadataOptionsRequest
Source§fn clone(&self) -> InstanceMetadataOptionsRequest
fn clone(&self) -> InstanceMetadataOptionsRequest
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl PartialEq for InstanceMetadataOptionsRequest
impl PartialEq for InstanceMetadataOptionsRequest
Source§fn eq(&self, other: &InstanceMetadataOptionsRequest) -> bool
fn eq(&self, other: &InstanceMetadataOptionsRequest) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for InstanceMetadataOptionsRequest
Auto Trait Implementations§
impl Freeze for InstanceMetadataOptionsRequest
impl RefUnwindSafe for InstanceMetadataOptionsRequest
impl Send for InstanceMetadataOptionsRequest
impl Sync for InstanceMetadataOptionsRequest
impl Unpin for InstanceMetadataOptionsRequest
impl UnwindSafe for InstanceMetadataOptionsRequest
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);