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 CreateAssociation operation. A State Manager association defines the state that you want to maintain on your managed nodes. For example, an association can specify that anti-virus software must be installed and running on your managed nodes, or that certain ports must be closed. For static targets, the association specifies a schedule for when the configuration is reapplied. For dynamic targets, such as an Amazon Web Services resource group or an Amazon Web Services autoscaling group, State Manager, a capability of Amazon Web Services Systems Manager applies the configuration when new managed nodes are added to the group. The association also specifies actions to take when applying the configuration. For example, an association for anti-virus software might run once a day. If the software isn't installed, then State Manager installs it. If the software is installed, but the service isn't running, then the association might instruct State Manager to start the service.
Namespace: Amazon.SimpleSystemsManagement.Model
Assembly: AWSSDK.SimpleSystemsManagement.dll
Version: 3.x.y.z
public class CreateAssociationRequest : AmazonSimpleSystemsManagementRequest IAmazonWebServiceRequest
The CreateAssociationRequest type exposes the following members
Name | Description | |
---|---|---|
CreateAssociationRequest() |
Empty constructor used to set properties independently even when a simple constructor is available |
|
CreateAssociationRequest(string, string) |
Instantiates CreateAssociationRequest with the parameterized properties |
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 create a new association, 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 isn't supported for rate expressions. |
|
AssociationName | System.String |
Gets and sets the property AssociationName. Specify a descriptive name for the association. |
|
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 to associate with the targets. Can be a specific version or the default version.
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
|
|
InstanceId | System.String |
Gets and sets the property InstanceId. The managed node ID.
|
|
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 Amazon Web Services account. For Systems Manager documents (SSM documents) 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 Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request. |
|
Parameters | System.Collections.Generic.Dictionary<System.String, System.Collections.Generic.List<System.String>> |
Gets and sets the property Parameters. The parameters for the runtime configuration of the document. |
|
ScheduleExpression | System.String |
Gets and sets the property ScheduleExpression. A cron expression when the association will be applied to the targets. |
|
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 |
|
Tags | System.Collections.Generic.List<Amazon.SimpleSystemsManagement.Model.Tag> |
Gets and sets the property Tags. Adds or overwrites one or more tags for a State Manager association. Tags are metadata that you can assign to your Amazon Web Services resources. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. |
|
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 create 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 for the association. You can target managed nodes by using tags, Amazon
Web Services resource groups, all managed nodes in an Amazon Web Services account,
or individual managed node IDs. You can target all managed nodes in an Amazon Web
Services account by specifying the |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5