AssociationDescription

Describes the parameters for a document.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The details for the CloudWatch alarm you want to apply to an automation or command.

Link copied to clipboard

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 isn't supported for rate expressions.

Link copied to clipboard

The association ID.

Link copied to clipboard

The association name.

Link copied to clipboard

The association version.

Link copied to clipboard

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 tool in Amazon Web Services Systems Manager.

Link copied to clipboard

The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar in the Amazon Web Services Systems Manager User Guide.

Link copied to clipboard

The severity level that is assigned to the association.

Link copied to clipboard

The date when the association was made.

Link copied to clipboard

The document version.

Link copied to clipboard

The number of hours that an association can run on specified targets. After the resulting cutoff time passes, associations that are currently running are cancelled, and no pending executions are started on remaining targets.

Link copied to clipboard

The managed node ID.

Link copied to clipboard

The date on which the association was last run.

Link copied to clipboard

The last date on which the association was successfully run.

Link copied to clipboard

The date when the association was last updated.

Link copied to clipboard

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.

Link copied to clipboard

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 MaxError to 10%, then the system stops sending the request when the sixth error is received.

Link copied to clipboard
val name: String?

The name of the SSM document.

Link copied to clipboard

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

Link copied to clipboard

Information about the association.

Link copied to clipboard

A description of the parameters for a document.

Link copied to clipboard

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

Link copied to clipboard

Number of days to wait after the scheduled day to run an association.

Link copied to clipboard

The association status.

Link copied to clipboard

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.

Link copied to clipboard

The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.

Link copied to clipboard

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

Link copied to clipboard

The managed nodes targeted by the request.

Link copied to clipboard

The CloudWatch alarm that was invoked during the association.

Functions

Link copied to clipboard
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String