Struct aws_sdk_ssm::types::AssociationDescription

source ·

#[non_exhaustive]
pub struct AssociationDescription { /* private fields */ }

Expand description

Describes the parameters for a document.

Implementations§

source §

impl AssociationDescription

source

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

The name of the SSM document.

source

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

The managed node ID.

source

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

The association version.

source

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

The date when the association was made.

source

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

The date when the association was last updated.

source

pub fn status(&self) -> Option<&AssociationStatus>

The association status.

source

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

Information about the association.

source

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

The document version.

source

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

Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.

source

pub fn parameters(&self) -> Option<&HashMap<String, Vec<String>>>

A description of the parameters for a document.

source

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

The association ID.

source

pub fn targets(&self) -> Option<&[Target]>

The managed nodes targeted by the request.

source

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

A cron expression that specifies a schedule when the association runs.

source

pub fn output_location(&self) -> Option<&InstanceAssociationOutputLocation>

An S3 bucket where you want to store the output details of the request.

source

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

The date on which the association was last run.

source

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

The last date on which the association was successfully run.

source

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

The association name.

source

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

The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 managed nodes and set MaxError to 10%, then the system stops sending the request when the sixth error is received.

Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.

source

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

The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.

If a new managed node starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new managed node will process its association within the limit specified for MaxConcurrency.

source

pub fn compliance_severity(&self) -> Option<&AssociationComplianceSeverity>

The severity level that is assigned to the association.

source

pub fn sync_compliance(&self) -> Option<&AssociationSyncCompliance>

The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.

In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a capability of Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.

By default, all associations use AUTO mode.

source

pub fn apply_only_at_cron_interval(&self) -> bool

By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter isn't supported for rate expressions.

source

pub fn calendar_names(&self) -> Option<&[String]>

The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.

source