Struct rusoto_ssm::CreateAssociationRequest

pub struct CreateAssociationRequest {
    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 targets: Option<Vec<Target>>,
}

Fields

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 you want to associate with the target(s). Can be a specific version or the default version.

instance_id: Option<String>

The instance ID.

InstanceId has been deprecated. To specify an instance ID for an association, use the Targets parameter. If you use the parameter InstanceId, you cannot use the parameters AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation, or ScheduleExpression. To use these parameters, you must use the Targets parameter.

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:partition: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 Amazon S3 bucket where you want to store the output details of the request.

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

The parameters for the runtime configuration of the document.

schedule_expression: Option<String>

A cron expression when the association will be applied to the target(s).

targets: Option<Vec<Target>>

The targets (either instances or tags) for the association. You must specify a value for Targets if you don't specify a value for InstanceId.

Trait Implementations

impl Clone for CreateAssociationRequest

fn clone(&self) -> CreateAssociationRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for CreateAssociationRequest

fn default() -> CreateAssociationRequest

Returns the "default value" for a type.

impl PartialEq<CreateAssociationRequest> for CreateAssociationRequest

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

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

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

This method tests for !=.

impl Debug for CreateAssociationRequest

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

Formats the value using the given formatter.

impl Serialize for CreateAssociationRequest

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

Serialize this value into the given Serde serializer.