createAssociation method

Future<CreateAssociationResult> createAssociation({ required String name, bool? applyOnlyAtCronInterval, String? associationName, String? automationTargetParameterName, AssociationComplianceSeverity? complianceSeverity, String? documentVersion, String? instanceId, String? maxConcurrency, String? maxErrors, InstanceAssociationOutputLocation? outputLocation, Map<String, List<String>>? parameters, String? scheduleExpression, AssociationSyncCompliance? syncCompliance, List<TargetLocation>? targetLocations, List<Target>? targets, })

A State Manager association defines the state that you want to maintain on your instances. For example, an association can specify that anti-virus software must be installed and running on your instances, 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 AWS Resource Group or an AWS Autoscaling Group, State Manager applies the configuration when new instances 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 is not installed, then State Manager installs it. If the software is installed, but the service is not running, then the association might instruct State Manager to start the service.

May throw AssociationAlreadyExists. May throw AssociationLimitExceeded. May throw InternalServerError. May throw InvalidDocument. May throw InvalidDocumentVersion. May throw InvalidInstanceId. May throw UnsupportedPlatformType. May throw InvalidOutputLocation. May throw InvalidParameters. May throw InvalidTarget. May throw InvalidSchedule.

Parameter name : 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.

Parameter applyOnlyAtCronInterval : 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.

Parameter associationName : Specify a descriptive name for the association.

Parameter automationTargetParameterName : Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.

Parameter complianceSeverity : The severity level to assign to the association.

Parameter documentVersion : The document version you want to associate with the target(s). Can be a specific version or the default version.

Parameter instanceId : The instance ID.

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

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

Parameter outputLocation : An S3 bucket where you want to store the output details of the request.

Parameter parameters : The parameters for the runtime configuration of the document.

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

Parameter syncCompliance : 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.

Parameter targetLocations : A location is a combination of AWS Regions and AWS accounts where you want to run the association. Use this action to create an association in multiple Regions and multiple accounts.

Parameter targets : The targets for the association. You can target instances by using tags, AWS Resource Groups, all instances in an AWS account, or individual instance IDs. For more information about choosing targets for an association, see Using targets and rate controls with State Manager associations in the AWS Systems Manager User Guide.

Implementation

Future<CreateAssociationResult> createAssociation({
  required String name,
  bool? applyOnlyAtCronInterval,
  String? associationName,
  String? automationTargetParameterName,
  AssociationComplianceSeverity? complianceSeverity,
  String? documentVersion,
  String? instanceId,
  String? maxConcurrency,
  String? maxErrors,
  InstanceAssociationOutputLocation? outputLocation,
  Map<String, List<String>>? parameters,
  String? scheduleExpression,
  AssociationSyncCompliance? syncCompliance,
  List<TargetLocation>? targetLocations,
  List<Target>? targets,
}) async {
  ArgumentError.checkNotNull(name, 'name');
  _s.validateStringLength(
    'automationTargetParameterName',
    automationTargetParameterName,
    1,
    50,
  );
  _s.validateStringLength(
    'maxConcurrency',
    maxConcurrency,
    1,
    7,
  );
  _s.validateStringLength(
    'maxErrors',
    maxErrors,
    1,
    7,
  );
  _s.validateStringLength(
    'scheduleExpression',
    scheduleExpression,
    1,
    256,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AmazonSSM.CreateAssociation'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'Name': name,
      if (applyOnlyAtCronInterval != null)
        'ApplyOnlyAtCronInterval': applyOnlyAtCronInterval,
      if (associationName != null) 'AssociationName': associationName,
      if (automationTargetParameterName != null)
        'AutomationTargetParameterName': automationTargetParameterName,
      if (complianceSeverity != null)
        'ComplianceSeverity': complianceSeverity.toValue(),
      if (documentVersion != null) 'DocumentVersion': documentVersion,
      if (instanceId != null) 'InstanceId': instanceId,
      if (maxConcurrency != null) 'MaxConcurrency': maxConcurrency,
      if (maxErrors != null) 'MaxErrors': maxErrors,
      if (outputLocation != null) 'OutputLocation': outputLocation,
      if (parameters != null) 'Parameters': parameters,
      if (scheduleExpression != null)
        'ScheduleExpression': scheduleExpression,
      if (syncCompliance != null) 'SyncCompliance': syncCompliance.toValue(),
      if (targetLocations != null) 'TargetLocations': targetLocations,
      if (targets != null) 'Targets': targets,
    },
  );

  return CreateAssociationResult.fromJson(jsonResponse.body);
}