#[non_exhaustive]pub struct Association {Show 13 fields
pub name: Option<String>,
pub instance_id: Option<String>,
pub association_id: Option<String>,
pub association_version: Option<String>,
pub document_version: Option<String>,
pub targets: Option<Vec<Target>>,
pub last_execution_date: Option<DateTime>,
pub overview: Option<AssociationOverview>,
pub schedule_expression: Option<String>,
pub association_name: Option<String>,
pub schedule_offset: Option<i32>,
pub duration: Option<i32>,
pub target_maps: Option<Vec<HashMap<String, Vec<String>>>>,
}
Expand description
Describes an association of a Amazon Web Services Systems Manager document (SSM document) and a managed node.
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.name: Option<String>
The name of the SSM document.
instance_id: Option<String>
The managed node ID.
association_id: Option<String>
The ID created by the system when you create an association. An association is a binding between a document and a set of targets with a schedule.
association_version: Option<String>
The association version.
document_version: Option<String>
The version of the document used in the association. If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the apply-only-at-cron-interval
parameter.
State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the default
version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to default
.
targets: Option<Vec<Target>>
The managed nodes targeted by the request to create an association. You can target all managed nodes in an Amazon Web Services account by specifying the InstanceIds
key with a value of *
.
last_execution_date: Option<DateTime>
The date on which the association was last run.
overview: Option<AssociationOverview>
Information about the association.
schedule_expression: Option<String>
A cron expression that specifies a schedule when the association runs. The schedule runs in Coordinated Universal Time (UTC).
association_name: Option<String>
The association name.
schedule_offset: Option<i32>
Number of days to wait after the scheduled day to run an association.
duration: Option<i32>
The number of hours that an association can run on specified targets. After the resulting cutoff time passes, associations that are currently running are cancelled, and no pending executions are started on remaining targets.
target_maps: Option<Vec<HashMap<String, Vec<String>>>>
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
Implementations§
Source§impl Association
impl Association
Sourcepub fn instance_id(&self) -> Option<&str>
pub fn instance_id(&self) -> Option<&str>
The managed node ID.
Sourcepub fn association_id(&self) -> Option<&str>
pub fn association_id(&self) -> Option<&str>
The ID created by the system when you create an association. An association is a binding between a document and a set of targets with a schedule.
Sourcepub fn association_version(&self) -> Option<&str>
pub fn association_version(&self) -> Option<&str>
The association version.
Sourcepub fn document_version(&self) -> Option<&str>
pub fn document_version(&self) -> Option<&str>
The version of the document used in the association. If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the apply-only-at-cron-interval
parameter.
State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the default
version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to default
.
Sourcepub fn targets(&self) -> &[Target]
pub fn targets(&self) -> &[Target]
The managed nodes targeted by the request to create an association. You can target all managed nodes in an Amazon Web Services account by specifying the InstanceIds
key with a value of *
.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .targets.is_none()
.
Sourcepub fn last_execution_date(&self) -> Option<&DateTime>
pub fn last_execution_date(&self) -> Option<&DateTime>
The date on which the association was last run.
Sourcepub fn overview(&self) -> Option<&AssociationOverview>
pub fn overview(&self) -> Option<&AssociationOverview>
Information about the association.
Sourcepub fn schedule_expression(&self) -> Option<&str>
pub fn schedule_expression(&self) -> Option<&str>
A cron expression that specifies a schedule when the association runs. The schedule runs in Coordinated Universal Time (UTC).
Sourcepub fn association_name(&self) -> Option<&str>
pub fn association_name(&self) -> Option<&str>
The association name.
Sourcepub fn schedule_offset(&self) -> Option<i32>
pub fn schedule_offset(&self) -> Option<i32>
Number of days to wait after the scheduled day to run an association.
Sourcepub fn duration(&self) -> Option<i32>
pub fn duration(&self) -> Option<i32>
The number of hours that an association can run on specified targets. After the resulting cutoff time passes, associations that are currently running are cancelled, and no pending executions are started on remaining targets.
Sourcepub fn target_maps(&self) -> &[HashMap<String, Vec<String>>]
pub fn target_maps(&self) -> &[HashMap<String, Vec<String>>]
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .target_maps.is_none()
.
Source§impl Association
impl Association
Sourcepub fn builder() -> AssociationBuilder
pub fn builder() -> AssociationBuilder
Creates a new builder-style object to manufacture Association
.
Trait Implementations§
Source§impl Clone for Association
impl Clone for Association
Source§fn clone(&self) -> Association
fn clone(&self) -> Association
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for Association
impl Debug for Association
Source§impl PartialEq for Association
impl PartialEq for Association
impl StructuralPartialEq for Association
Auto Trait Implementations§
impl Freeze for Association
impl RefUnwindSafe for Association
impl Send for Association
impl Sync for Association
impl Unpin for Association
impl UnwindSafe for Association
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);