AssociationState class

Input properties used for looking up and filtering Association resources.

Constructors

AssociationState({Input<bool?>? applyOnlyAtCronInterval, Input<String?>? arn, Input<String?>? associationId, Input<String?>? associationName, Input<String?>? automationTargetParameterName, Input<List<String>?>? calendarNames, Input<String?>? complianceSeverity, Input<String?>? documentVersion, Input<String?>? maxConcurrency, Input<String?>? maxErrors, Input<String?>? name, Input<AssociationOutputLocation?>? outputLocation, Input<Map<String, String>?>? parameters, Input<String?>? region, Input<String?>? scheduleExpression, Input<String?>? syncCompliance, Input<Map<String, String>?>? tags, Input<Map<String, String>?>? tagsAll, Input<List<AssociationTarget>?>? targets, Input<int?>? waitForSuccessTimeoutSeconds})
Creates a new AssociationState. applyOnlyAtCronInterval By default, when you create a new or update associations, the system runs it immediately and then according to the schedule you specified. Enable this option if you do not want an association to run immediately after you create or update it. This parameter is not supported for rate expressions. Default: false. arn The ARN of the SSM association associationId The ID of the SSM association. associationName The descriptive name for the association. 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. This should be set to the SSM document parameter that will define how your automation will branch out. calendarNames One or more Systems Manager Change Calendar names. The association runs only when the Change Calendar is open. complianceSeverity The compliance severity for the association. Can be one of the following: UNSPECIFIED, LOW, MEDIUM, HIGH or CRITICAL documentVersion The document version you want to associate with the target(s). Can be a specific version or the default version. 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%. maxErrors The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify a number, for example 10, or a percentage of the target set, for example 10%. If you specify a threshold of 3, the stop command is sent when the fourth error is returned. If you specify a threshold of 10% for 50 associations, the stop command is sent when the sixth error is returned. name The name of the SSM document to apply. outputLocation An output location block. Output Location is documented below. parameters A block of arbitrary string parameters to pass to the SSM document. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. scheduleExpression A cron or rate expression that specifies when the association runs. syncCompliance The mode for generating association compliance. You can specify AUTO or MANUAL. tags A map of tags to assign to the object. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. tagsAll A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block. targets A block containing the targets of the SSM association. Targets are documented below. AWS currently supports a maximum of 5 targets. waitForSuccessTimeoutSeconds The number of seconds to wait for the association status to be Success. If Success status is not reached within the given time, create opration will fail.
const
AssociationState.fromMap(Map<String, dynamic> map)
factory

Properties

applyOnlyAtCronInterval → Input<bool?>?
By default, when you create a new or update associations, the system runs it immediately and then according to the schedule you specified. Enable this option if you do not want an association to run immediately after you create or update it. This parameter is not supported for rate expressions. Default: false.
final
arn → Input<String?>?
The ARN of the SSM association
final
associationId → Input<String?>?
The ID of the SSM association.
final
associationName → Input<String?>?
The descriptive name for the association.
final
automationTargetParameterName → Input<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. This should be set to the SSM document parameter that will define how your automation will branch out.
final
calendarNames → Input<List<String>?>?
One or more Systems Manager Change Calendar names. The association runs only when the Change Calendar is open.
final
complianceSeverity → Input<String?>?
The compliance severity for the association. Can be one of the following: UNSPECIFIED, LOW, MEDIUM, HIGH or CRITICAL
final
documentVersion → Input<String?>?
The document version you want to associate with the target(s). Can be a specific version or the default version.
final
hashCode → int
The hash code for this object.
no setterinherited
maxConcurrency → Input<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%.
final
maxErrors → Input<String?>?
The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify a number, for example 10, or a percentage of the target set, for example 10%. If you specify a threshold of 3, the stop command is sent when the fourth error is returned. If you specify a threshold of 10% for 50 associations, the stop command is sent when the sixth error is returned.
final
name → Input<String?>?
The name of the SSM document to apply.
final
outputLocation → Input<AssociationOutputLocation?>?
An output location block. Output Location is documented below.
final
parameters → Input<Map<String, String>?>?
A block of arbitrary string parameters to pass to the SSM document.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scheduleExpression → Input<String?>?
A cron or rate expression that specifies when the association runs.
final
syncCompliance → Input<String?>?
The mode for generating association compliance. You can specify AUTO or MANUAL.
final
tags → Input<Map<String, String>?>?
A map of tags to assign to the object. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
tagsAll → Input<Map<String, String>?>?
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
final
targets → Input<List<AssociationTarget>?>?
A block containing the targets of the SSM association. Targets are documented below. AWS currently supports a maximum of 5 targets.
final
waitForSuccessTimeoutSeconds → Input<int?>?
The number of seconds to wait for the association status to be Success. If Success status is not reached within the given time, create opration will fail.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited