Struct rusoto_ssm::CreateAssociationBatchRequestEntry

pub struct CreateAssociationBatchRequestEntry {
    pub apply_only_at_cron_interval: Option<bool>,
    pub association_name: Option<String>,
    pub automation_target_parameter_name: Option<String>,
    pub compliance_severity: Option<String>,
    pub document_version: Option<String>,
    pub instance_id: Option<String>,
    pub max_concurrency: Option<String>,
    pub max_errors: Option<String>,
    pub name: String,
    pub output_location: Option<InstanceAssociationOutputLocation>,
    pub parameters: Option<HashMap<String, Vec<String>>>,
    pub schedule_expression: Option<String>,
    pub sync_compliance: Option<String>,
    pub target_locations: Option<Vec<TargetLocation>>,
    pub targets: Option<Vec<Target>>,
}

Describes the association of a Systems Manager SSM document and an instance.

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

Specify a descriptive name for the association.

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.

compliance_severity: Option<String>

The severity level to assign to the association.

document_version: Option<String>

The document version.

instance_id: Option<String>

The ID of the instance.

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

The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents.

You can specify AWS-predefined documents, documents you created, or a document that is shared with you from another account.

For SSM documents that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format:

arn:aws:ssm:region:account-id:document/document-name

For example:

arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document

For AWS-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My-Document.

output_location: Option<InstanceAssociationOutputLocation>

An S3 bucket where you want to store the results of this request.

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.

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

Use this action to create an association in multiple Regions and multiple accounts.

targets: Option<Vec<Target>>

The instances targeted by the request.

Trait Implementations

impl Clone for CreateAssociationBatchRequestEntry

pub fn clone(&self) -> CreateAssociationBatchRequestEntry

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateAssociationBatchRequestEntry

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

Formats the value using the given formatter.

impl Default for CreateAssociationBatchRequestEntry

pub fn default() -> CreateAssociationBatchRequestEntry

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for CreateAssociationBatchRequestEntry

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<CreateAssociationBatchRequestEntry> for CreateAssociationBatchRequestEntry

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

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

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

This method tests for !=.

impl Serialize for CreateAssociationBatchRequestEntry

pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CreateAssociationBatchRequestEntry