#[non_exhaustive]pub struct LockRuleOutput {
pub identifier: Option<String>,
pub description: Option<String>,
pub resource_type: Option<ResourceType>,
pub retention_period: Option<RetentionPeriod>,
pub resource_tags: Option<Vec<ResourceTag>>,
pub status: Option<RuleStatus>,
pub lock_configuration: Option<LockConfiguration>,
pub lock_state: Option<LockState>,
pub rule_arn: Option<String>,
pub exclude_resource_tags: Option<Vec<ResourceTag>>,
/* private fields */
}
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.identifier: Option<String>
The unique ID of the retention rule.
description: Option<String>
The retention rule description.
resource_type: Option<ResourceType>
The resource type retained by the retention rule.
retention_period: Option<RetentionPeriod>
Information about the retention period for which the retention rule is to retain resources.
\[Tag-level retention rules only\] Information about the resource tags used to identify resources that are retained by the retention rule.
status: Option<RuleStatus>
The state of the retention rule. Only retention rules that are in the available
state retain resources.
lock_configuration: Option<LockConfiguration>
Information about the retention rule lock configuration.
lock_state: Option<LockState>
\[Region-level retention rules only\] The lock state for the retention rule.
-
locked
- The retention rule is locked and can't be modified or deleted. -
pending_unlock
- The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired. -
unlocked
- The retention rule is unlocked and it can be modified or deleted by any user with the required permissions. -
null
- The retention rule has never been locked. Once a retention rule has been locked, it can transition between thelocked
andunlocked
states only; it can never transition back tonull
.
rule_arn: Option<String>
The Amazon Resource Name (ARN) of the retention rule.
\[Region-level retention rules only\] Information about the exclusion tags used to identify resources that are to be excluded, or ignored, by the retention rule.
Implementations§
Source§impl LockRuleOutput
impl LockRuleOutput
Sourcepub fn identifier(&self) -> Option<&str>
pub fn identifier(&self) -> Option<&str>
The unique ID of the retention rule.
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
The retention rule description.
Sourcepub fn resource_type(&self) -> Option<&ResourceType>
pub fn resource_type(&self) -> Option<&ResourceType>
The resource type retained by the retention rule.
Sourcepub fn retention_period(&self) -> Option<&RetentionPeriod>
pub fn retention_period(&self) -> Option<&RetentionPeriod>
Information about the retention period for which the retention rule is to retain resources.
\[Tag-level retention rules only\] Information about the resource tags used to identify resources that are retained by the retention rule.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .resource_tags.is_none()
.
Sourcepub fn status(&self) -> Option<&RuleStatus>
pub fn status(&self) -> Option<&RuleStatus>
The state of the retention rule. Only retention rules that are in the available
state retain resources.
Sourcepub fn lock_configuration(&self) -> Option<&LockConfiguration>
pub fn lock_configuration(&self) -> Option<&LockConfiguration>
Information about the retention rule lock configuration.
Sourcepub fn lock_state(&self) -> Option<&LockState>
pub fn lock_state(&self) -> Option<&LockState>
\[Region-level retention rules only\] The lock state for the retention rule.
-
locked
- The retention rule is locked and can't be modified or deleted. -
pending_unlock
- The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired. -
unlocked
- The retention rule is unlocked and it can be modified or deleted by any user with the required permissions. -
null
- The retention rule has never been locked. Once a retention rule has been locked, it can transition between thelocked
andunlocked
states only; it can never transition back tonull
.
\[Region-level retention rules only\] Information about the exclusion tags used to identify resources that are to be excluded, or ignored, by the retention rule.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .exclude_resource_tags.is_none()
.
Source§impl LockRuleOutput
impl LockRuleOutput
Sourcepub fn builder() -> LockRuleOutputBuilder
pub fn builder() -> LockRuleOutputBuilder
Creates a new builder-style object to manufacture LockRuleOutput
.
Trait Implementations§
Source§impl Clone for LockRuleOutput
impl Clone for LockRuleOutput
Source§fn clone(&self) -> LockRuleOutput
fn clone(&self) -> LockRuleOutput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for LockRuleOutput
impl Debug for LockRuleOutput
Source§impl PartialEq for LockRuleOutput
impl PartialEq for LockRuleOutput
Source§impl RequestId for LockRuleOutput
impl RequestId for LockRuleOutput
Source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None
if the service could not be reached.impl StructuralPartialEq for LockRuleOutput
Auto Trait Implementations§
impl Freeze for LockRuleOutput
impl RefUnwindSafe for LockRuleOutput
impl Send for LockRuleOutput
impl Sync for LockRuleOutput
impl Unpin for LockRuleOutput
impl UnwindSafe for LockRuleOutput
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);