CreateAssociationBatchRequestEntry class

Describes the association of a Systems Manager SSM document and an instance.

Constructors

CreateAssociationBatchRequestEntry({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})

CreateAssociationBatchRequestEntry.fromJson(Map<String, dynamic> json)

factory

Properties

applyOnlyAtCronInterval → bool?

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.

final

associationName → String?

Specify a descriptive name for the association.

final

automationTargetParameterName → 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.

final

complianceSeverity → AssociationComplianceSeverity?

The severity level to assign to the association.

final

documentVersion → String?

The document version.

final

hashCode → int

The hash code for this object.

no setter, inherited

instanceId → String?

The ID of the instance.

final

maxConcurrency → 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.

final

maxErrors → 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.

final

name → String

The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents.

final

outputLocation → InstanceAssociationOutputLocation?

An S3 bucket where you want to store the results of this request.

final

parameters → Map<String, List<String>>?

A description of the parameters for a document.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

scheduleExpression → String?

A cron expression that specifies a schedule when the association runs.

final

syncCompliance → AssociationSyncCompliance?

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.

final

targetLocations → List<TargetLocation>?

Use this action to create an association in multiple Regions and multiple accounts.

final

targets → List<Target>?

The instances targeted by the request.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited