Struct aws_sdk_ssm::input::update_association_input::Builder [−][src]
#[non_exhaustive]pub struct Builder { /* fields omitted */ }
Expand description
A builder for UpdateAssociationInput
Implementations
The ID of the association you want to update.
The ID of the association you want to update.
Adds a key-value pair to parameters
.
To override the contents of this collection use set_parameters
.
The parameters you want to update for the association. If you create a parameter using
Parameter Store, a capability of Amazon Web Services Systems Manager, you can reference the parameter using
{{ssm:parameter-name}}
.
The parameters you want to update for the association. If you create a parameter using
Parameter Store, a capability of Amazon Web Services Systems Manager, you can reference the parameter using
{{ssm:parameter-name}}
.
The document version you want update for the association.
The document version you want update for the association.
The cron expression used to schedule the association that you want to update.
The cron expression used to schedule the association that you want to update.
An S3 bucket where you want to store the results of this request.
An S3 bucket where you want to store the results of this request.
The name of the SSM Command document or Automation runbook that contains the configuration information for the managed node.
You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.
For Systems Manager document (SSM document) that are shared with you from other Amazon Web Services 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 Amazon Web Services-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
.
The name of the SSM Command document or Automation runbook that contains the configuration information for the managed node.
You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.
For Systems Manager document (SSM document) that are shared with you from other Amazon Web Services 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 Amazon Web Services-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
.
Appends an item to targets
.
To override the contents of this collection use set_targets
.
The targets of the association.
The targets of the association.
The name of the association that you want to update.
The name of the association that you want to update.
This parameter is provided for concurrency control purposes. You must specify the latest
association version in the service. If you want to ensure that this request succeeds, either
specify $LATEST
, or omit this parameter.
This parameter is provided for concurrency control purposes. You must specify the latest
association version in the service. If you want to ensure that this request succeeds, either
specify $LATEST
, or omit this parameter.
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.
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.
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.
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.
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
.
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
.
The severity level to assign to the association.
The severity level to assign to the association.
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.
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.
By default, when you update an association, the system runs it immediately after it is updated and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you update it. This parameter isn't supported for rate expressions.
Also, if you specified this option when you created the association, you can reset it. To do
so, specify the no-apply-only-at-cron-interval
parameter when you update the
association from the command line. This parameter forces the association to run immediately after
updating it and according to the interval specified.
By default, when you update an association, the system runs it immediately after it is updated and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you update it. This parameter isn't supported for rate expressions.
Also, if you specified this option when you created the association, you can reset it. To do
so, specify the no-apply-only-at-cron-interval
parameter when you update the
association from the command line. This parameter forces the association to run immediately after
updating it and according to the interval specified.
Appends an item to calendar_names
.
To override the contents of this collection use set_calendar_names
.
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your associations under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your associations under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.
Appends an item to target_locations
.
To override the contents of this collection use set_target_locations
.
A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association. Use this action to update an association in multiple Regions and multiple accounts.
A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association. Use this action to update an association in multiple Regions and multiple accounts.
Consumes the builder and constructs a UpdateAssociationInput
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for Builder
impl UnwindSafe for Builder
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more