AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Container for the parameters to the UpdateAssociation operation.
Updates an association. You can update the association name and version, the document
version, schedule, parameters, and Amazon Simple Storage Service (Amazon S3) output.
When you call UpdateAssociation
, the system removes all optional parameters
from the request and overwrites the association with null values for those parameters.
This is by design. You must specify all optional parameters in the call, even if you
are not changing the parameters. This includes the Name
parameter. Before calling
this API action, we recommend that you call the DescribeAssociation API operation
and make a note of all optional parameters required for your UpdateAssociation
call.
In order to call this API operation, a user, group, or role must be granted permission
to call the DescribeAssociation API operation. If you don't have permission
to call DescribeAssociation
, then you receive the following error: An error
occurred (AccessDeniedException) when calling the UpdateAssociation operation: User:
When you update an association, the association immediately runs against the specified
targets. You can add the ApplyOnlyAtCronInterval
parameter to run the association
during the next schedule run.
Namespace: Amazon.SimpleSystemsManagement.Model
Assembly: AWSSDK.SimpleSystemsManagement.dll
Version: 3.x.y.z
public class UpdateAssociationRequest : AmazonSimpleSystemsManagementRequest IAmazonWebServiceRequest
The UpdateAssociationRequest type exposes the following members
Name | Description | |
---|---|---|
UpdateAssociationRequest() |
Name | Type | Description | |
---|---|---|---|
AlarmConfiguration | Amazon.SimpleSystemsManagement.Model.AlarmConfiguration |
Gets and sets the property AlarmConfiguration. |
|
ApplyOnlyAtCronInterval | System.Boolean |
Gets and sets the property ApplyOnlyAtCronInterval. 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.
If you chose this option when you created an association and later you edit that association
or you make changes to the SSM document on which that association is based (by using
the Documents page in the console), State Manager applies the association at the next
specified cron interval. For example, if you chose the
You can reset this option. To do so, specify the |
|
AssociationId | System.String |
Gets and sets the property AssociationId. The ID of the association you want to update. |
|
AssociationName | System.String |
Gets and sets the property AssociationName. The name of the association that you want to update. |
|
AssociationVersion | System.String |
Gets and sets the property AssociationVersion.
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 |
|
AutomationTargetParameterName | System.String |
Gets and sets the property AutomationTargetParameterName. 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. |
|
CalendarNames | System.Collections.Generic.List<System.String> |
Gets and sets the property CalendarNames. 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. |
|
ComplianceSeverity | Amazon.SimpleSystemsManagement.AssociationComplianceSeverity |
Gets and sets the property ComplianceSeverity. The severity level to assign to the association. |
|
DocumentVersion | System.String |
Gets and sets the property DocumentVersion. The document version you want update for the association.
State Manager doesn't support running associations that use a new version of a document
if that document is shared from another account. State Manager always runs the |
|
Duration | System.Int32 |
Gets and sets the property Duration. The number of hours the association can run before it is canceled. Duration applies to associations that are currently running, and any pending and in progress commands on all targets. If a target was taken offline for the association to run, it is made available again immediately, without a reboot.
The
|
|
MaxConcurrency | System.String |
Gets and sets the property 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 |
|
MaxErrors | System.String |
Gets and sets the property MaxErrors.
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
Executions that are already running an association when |
|
Name | System.String |
Gets and sets the property Name. 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:
For example:
For Amazon Web Services-predefined documents and SSM documents you created in your
account, you only need to specify the document name. For example, |
|
OutputLocation | Amazon.SimpleSystemsManagement.Model.InstanceAssociationOutputLocation |
Gets and sets the property OutputLocation. An S3 bucket where you want to store the results of this request. |
|
Parameters | System.Collections.Generic.Dictionary<System.String, System.Collections.Generic.List<System.String>> |
Gets and sets the property 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 |
|
ScheduleExpression | System.String |
Gets and sets the property ScheduleExpression. The cron expression used to schedule the association that you want to update. |
|
ScheduleOffset | System.Int32 |
Gets and sets the property ScheduleOffset.
Number of days to wait after the scheduled day to run an association. For example,
if you specified a cron schedule of
To use offsets, you must specify the |
|
SyncCompliance | Amazon.SimpleSystemsManagement.AssociationSyncCompliance |
Gets and sets the property SyncCompliance.
The mode for generating association compliance. You can specify
In
By default, all associations use |
|
TargetLocations | System.Collections.Generic.List<Amazon.SimpleSystemsManagement.Model.TargetLocation> |
Gets and sets the property TargetLocations. 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. |
|
TargetMaps | System.Collections.Generic.List<System.Collections.Generic.Dictionary<System.String, System.Collections.Generic.List<System.String>>> |
Gets and sets the property TargetMaps. A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together. |
|
Targets | System.Collections.Generic.List<Amazon.SimpleSystemsManagement.Model.Target> |
Gets and sets the property Targets. The targets of the association. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5