Struct aws_sdk_ssm::types::Association

#[non_exhaustive]
pub struct Association {

    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>>>>,
}

Describes an association of a Amazon Web Services Systems Manager document (SSM document) and a managed node.

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.

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

impl Association

pub fn name(&self) -> Option<&str>

The name of the SSM document.

pub fn instance_id(&self) -> Option<&str>

The managed node ID.

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.

pub fn association_version(&self) -> Option<&str>

The association version.

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.

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().

pub fn last_execution_date(&self) -> Option<&DateTime>

The date on which the association was last run.

pub fn overview(&self) -> Option<&AssociationOverview>

Information about the association.

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).

pub fn association_name(&self) -> Option<&str>

The association name.

pub fn schedule_offset(&self) -> Option<i32>

Number of days to wait after the scheduled day to run an association.

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.

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().

impl Association

pub fn builder() -> AssociationBuilder

Creates a new builder-style object to manufacture Association.

Trait Implementations

impl Clone for Association

fn clone(&self) -> Association

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Association

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

Formats the value using the given formatter.

impl PartialEq for Association

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Association