Struct rusoto_ssm::AssociationDescription

pub struct AssociationDescription {

    pub apply_only_at_cron_interval: Option<bool>,
    pub association_id: Option<String>,
    pub association_name: Option<String>,
    pub association_version: Option<String>,
    pub automation_target_parameter_name: Option<String>,
    pub calendar_names: Option<Vec<String>>,
    pub compliance_severity: Option<String>,
    pub date: Option<f64>,
    pub document_version: Option<String>,
    pub instance_id: Option<String>,
    pub last_execution_date: Option<f64>,
    pub last_successful_execution_date: Option<f64>,
    pub last_update_association_date: Option<f64>,
    pub max_concurrency: Option<String>,
    pub max_errors: Option<String>,
    pub name: Option<String>,
    pub output_location: Option<InstanceAssociationOutputLocation>,
    pub overview: Option<AssociationOverview>,
    pub parameters: Option<HashMap<String, Vec<String>>>,
    pub schedule_expression: Option<String>,
    pub status: Option<AssociationStatus>,
    pub sync_compliance: Option<String>,
    pub target_locations: Option<Vec<TargetLocation>>,
    pub targets: Option<Vec<Target>>,
}

Describes the parameters for a document.

Fields

apply_only_at_cron_interval: Option<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 is not supported for rate expressions.

association_id: Option<String>

The association ID.

association_name: Option<String>

The association name.

association_version: Option<String>

The association version.

automation_target_parameter_name: Option<String>

Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.

calendar_names: Option<Vec<String>>

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

compliance_severity: Option<String>

The severity level that is assigned to the association.

date: Option<f64>

The date when the association was made.

document_version: Option<String>

The document version.

instance_id: Option<String>

The ID of the instance.

last_execution_date: Option<f64>

The date on which the association was last run.

last_successful_execution_date: Option<f64>

The last date on which the association was successfully run.

last_update_association_date: Option<f64>

The date when the association was last updated.

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 instance 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 instance will process its association within the limit specified for MaxConcurrency.

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

name: Option<String>

The name of the Systems Manager document.

output_location: Option<InstanceAssociationOutputLocation>

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

overview: Option<AssociationOverview>

Information about the association.

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

A description of the parameters for a document.

schedule_expression: Option<String>

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

status: Option<AssociationStatus>

The association status.

sync_compliance: Option<String>

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 action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.

By default, all associations use AUTO mode.

target_locations: Option<Vec<TargetLocation>>

The combination of AWS Regions and AWS accounts where you want to run the association.

targets: Option<Vec<Target>>

The instances targeted by the request.

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 Default for AssociationDescription

fn default() -> AssociationDescription

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AssociationDescription

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<AssociationDescription> 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: &AssociationDescription) -> bool

This method tests for !=.

impl StructuralPartialEq for AssociationDescription