Struct aws_sdk_ssm::types::AssociationDescription

#[non_exhaustive]
pub struct AssociationDescription {

    pub name: Option<String>,
    pub instance_id: Option<String>,
    pub association_version: Option<String>,
    pub date: Option<DateTime>,
    pub last_update_association_date: Option<DateTime>,
    pub status: Option<AssociationStatus>,
    pub overview: Option<AssociationOverview>,
    pub document_version: Option<String>,
    pub automation_target_parameter_name: Option<String>,
    pub parameters: Option<HashMap<String, Vec<String>>>,
    pub association_id: Option<String>,
    pub targets: Option<Vec<Target>>,
    pub schedule_expression: Option<String>,
    pub output_location: Option<InstanceAssociationOutputLocation>,
    pub last_execution_date: Option<DateTime>,
    pub last_successful_execution_date: Option<DateTime>,
    pub association_name: Option<String>,
    pub max_errors: Option<String>,
    pub max_concurrency: Option<String>,
    pub compliance_severity: Option<AssociationComplianceSeverity>,
    pub sync_compliance: Option<AssociationSyncCompliance>,
    pub apply_only_at_cron_interval: bool,
    pub calendar_names: Option<Vec<String>>,
    pub target_locations: Option<Vec<TargetLocation>>,
    pub schedule_offset: Option<i32>,
    pub duration: Option<i32>,
    pub target_maps: Option<Vec<HashMap<String, Vec<String>>>>,
    pub alarm_configuration: Option<AlarmConfiguration>,
    pub triggered_alarms: Option<Vec<AlarmStateInformation>>,
}

Describes the parameters for a document.

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_version: Option<String>

The association version.

date: Option<DateTime>

The date when the association was made.

last_update_association_date: Option<DateTime>

The date when the association was last updated.

status: Option<AssociationStatus>

The association status.

overview: Option<AssociationOverview>

Information about the association.

document_version: Option<String>

The document version.

automation_target_parameter_name: Option<String>

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.

parameters: Option<HashMap<String, Vec<String>>>

A description of the parameters for a document.

association_id: Option<String>

The association ID.

targets: Option<Vec<Target>>

The managed nodes targeted by the request.

schedule_expression: Option<String>

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

output_location: Option<InstanceAssociationOutputLocation>

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

last_execution_date: Option<DateTime>

The date on which the association was last run.

last_successful_execution_date: Option<DateTime>

The last date on which the association was successfully run.

association_name: Option<String>

The association name.

max_errors: Option<String>

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.

max_concurrency: Option<String>

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.

compliance_severity: Option<AssociationComplianceSeverity>

The severity level that is assigned to the association.

sync_compliance: 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.

apply_only_at_cron_interval: 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.

calendar_names: Option<Vec<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.

target_locations: Option<Vec<TargetLocation>>

The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.

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.

alarm_configuration: Option<AlarmConfiguration>

The details for the CloudWatch alarm you want to apply to an automation or command.

triggered_alarms: Option<Vec<AlarmStateInformation>>

The CloudWatch alarm that was invoked during the association.

Implementations

impl AssociationDescription

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_version(&self) -> Option<&str>

The association version.

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

The date when the association was made.

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

The date when the association was last updated.

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

The association status.

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

Information about the association.

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

The document version.

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.

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

A description of the parameters for a document.

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

The association ID.

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

The managed nodes targeted by the request.

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 schedule_expression(&self) -> Option<&str>

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

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

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

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

The date on which the association was last run.

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

The last date on which the association was successfully run.

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

The association name.

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.

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.

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

The severity level that is assigned to the association.

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.

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.

pub fn calendar_names(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .calendar_names.is_none().

pub fn target_locations(&self) -> &[TargetLocation]

The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.

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

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

pub fn alarm_configuration(&self) -> Option<&AlarmConfiguration>

The details for the CloudWatch alarm you want to apply to an automation or command.

pub fn triggered_alarms(&self) -> &[AlarmStateInformation]

The CloudWatch alarm that was invoked during the association.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .triggered_alarms.is_none().

impl AssociationDescription

pub fn builder() -> AssociationDescriptionBuilder

Creates a new builder-style object to manufacture AssociationDescription.

Trait Implementations

impl Clone for AssociationDescription

fn clone(&self) -> AssociationDescription

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AssociationDescription

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

Formats the value using the given formatter.

impl PartialEq for AssociationDescription

fn eq(&self, other: &AssociationDescription) -> 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 AssociationDescription