/AWS1/CL_SSMASSOCIATIONVRSINFO

Information about the association version.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_associationid TYPE /AWS1/SSMASSOCIATIONID /AWS1/SSMASSOCIATIONID

The ID created by the system when the association was created.

iv_associationversion TYPE /AWS1/SSMASSOCIATIONVERSION /AWS1/SSMASSOCIATIONVERSION

The association version.

iv_createddate TYPE /AWS1/SSMDATETIME /AWS1/SSMDATETIME

The date the association version was created.

iv_name TYPE /AWS1/SSMDOCUMENTARN /AWS1/SSMDOCUMENTARN

The name specified when the association was created.

iv_documentversion TYPE /AWS1/SSMDOCUMENTVERSION /AWS1/SSMDOCUMENTVERSION

The version of an Amazon Web Services Systems Manager document (SSM document) used when the association version was created.

it_parameters TYPE /AWS1/CL_SSMPARAMVALUELIST_W=>TT_PARAMETERS TT_PARAMETERS

Parameters specified when the association version was created.

it_targets TYPE /AWS1/CL_SSMTARGET=>TT_TARGETS TT_TARGETS

The targets specified for the association when the association version was created.

iv_scheduleexpression TYPE /AWS1/SSMSCHEDULEEXPRESSION /AWS1/SSMSCHEDULEEXPRESSION

The cron or rate schedule specified for the association when the association version was created.

io_outputlocation TYPE REF TO /AWS1/CL_SSMINSTASSOCIATIONO00 /AWS1/CL_SSMINSTASSOCIATIONO00

The location in Amazon S3 specified for the association when the association version was created.

iv_associationname TYPE /AWS1/SSMASSOCIATIONNAME /AWS1/SSMASSOCIATIONNAME

The name specified for the association version when the association version was created.

iv_maxerrors TYPE /AWS1/SSMMAXERRORS /AWS1/SSMMAXERRORS

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.

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.

iv_maxconcurrency TYPE /AWS1/SSMMAXCONCURRENCY /AWS1/SSMMAXCONCURRENCY

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 MaxConcurrency associations, the association is allowed to run. During the next association interval, the new managed node will process its association within the limit specified for MaxConcurrency.

iv_complianceseverity TYPE /AWS1/SSMASSOCIATIONCPLNCSEV00 /AWS1/SSMASSOCIATIONCPLNCSEV00

The severity level that is assigned to the association.

iv_synccompliance TYPE /AWS1/SSMASSOCIATIONSYNCCPLNC /AWS1/SSMASSOCIATIONSYNCCPLNC

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 operation. In this case, compliance data isn't managed by State Manager, a tool in Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.

By default, all associations use AUTO mode.

iv_applyonlyatcroninterval TYPE /AWS1/SSMAPPLYONLYATCRONINTE00 /AWS1/SSMAPPLYONLYATCRONINTE00

By default, when you create 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.

it_calendarnames TYPE /AWS1/CL_SSMCALENDARNAMEORAR00=>TT_CALENDARNAMEORARNLIST TT_CALENDARNAMEORARNLIST

The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations for this version 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.

it_targetlocations TYPE /AWS1/CL_SSMTARGETLOCATION=>TT_TARGETLOCATIONS TT_TARGETLOCATIONS

The combination of Amazon Web Services Regions and Amazon Web Services accounts where you wanted to run the association when this association version was created.

iv_scheduleoffset TYPE /AWS1/SSMSCHEDULEOFFSET /AWS1/SSMSCHEDULEOFFSET

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

iv_duration TYPE /AWS1/SSMDURATION /AWS1/SSMDURATION

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.

it_targetmaps TYPE /AWS1/CL_SSMTGTMAPVALUELIST_W=>TT_TARGETMAPS TT_TARGETMAPS

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

iv_assocdispatchassumerole TYPE /AWS1/SSMASCDISPASSUMEROLEARN /AWS1/SSMASCDISPASSUMEROLEARN

A role used by association to take actions on your behalf. State Manager will assume this role and call required APIs when dispatching configurations to nodes. If not specified, service-linked role for Systems Manager will be used by default.

---

Queryable Attributes

AssociationId

The ID created by the system when the association was created.

Accessible with the following methods

Method	Description
GET_ASSOCIATIONID()	Getter for ASSOCIATIONID, with configurable default
ASK_ASSOCIATIONID()	Getter for ASSOCIATIONID w/ exceptions if field has no value
HAS_ASSOCIATIONID()	Determine if ASSOCIATIONID has a value

AssociationVersion

The association version.

Accessible with the following methods

Method	Description
GET_ASSOCIATIONVERSION()	Getter for ASSOCIATIONVERSION, with configurable default
ASK_ASSOCIATIONVERSION()	Getter for ASSOCIATIONVERSION w/ exceptions if field has no
HAS_ASSOCIATIONVERSION()	Determine if ASSOCIATIONVERSION has a value

CreatedDate

The date the association version was created.

Accessible with the following methods

Method	Description
GET_CREATEDDATE()	Getter for CREATEDDATE, with configurable default
ASK_CREATEDDATE()	Getter for CREATEDDATE w/ exceptions if field has no value
HAS_CREATEDDATE()	Determine if CREATEDDATE has a value

Name

The name specified when the association was created.

Accessible with the following methods

Method	Description
GET_NAME()	Getter for NAME, with configurable default
ASK_NAME()	Getter for NAME w/ exceptions if field has no value
HAS_NAME()	Determine if NAME has a value

DocumentVersion

The version of an Amazon Web Services Systems Manager document (SSM document) used when the association version was created.

Accessible with the following methods

Method	Description
GET_DOCUMENTVERSION()	Getter for DOCUMENTVERSION, with configurable default
ASK_DOCUMENTVERSION()	Getter for DOCUMENTVERSION w/ exceptions if field has no val
HAS_DOCUMENTVERSION()	Determine if DOCUMENTVERSION has a value

Parameters

Parameters specified when the association version was created.

Accessible with the following methods

Method	Description
GET_PARAMETERS()	Getter for PARAMETERS, with configurable default
ASK_PARAMETERS()	Getter for PARAMETERS w/ exceptions if field has no value
HAS_PARAMETERS()	Determine if PARAMETERS has a value

Targets

The targets specified for the association when the association version was created.

Accessible with the following methods

Method	Description
GET_TARGETS()	Getter for TARGETS, with configurable default
ASK_TARGETS()	Getter for TARGETS w/ exceptions if field has no value
HAS_TARGETS()	Determine if TARGETS has a value

ScheduleExpression

The cron or rate schedule specified for the association when the association version was created.

Accessible with the following methods

Method	Description
GET_SCHEDULEEXPRESSION()	Getter for SCHEDULEEXPRESSION, with configurable default
ASK_SCHEDULEEXPRESSION()	Getter for SCHEDULEEXPRESSION w/ exceptions if field has no
HAS_SCHEDULEEXPRESSION()	Determine if SCHEDULEEXPRESSION has a value

OutputLocation

The location in Amazon S3 specified for the association when the association version was created.

Accessible with the following methods

Method	Description
GET_OUTPUTLOCATION()	Getter for OUTPUTLOCATION

AssociationName

The name specified for the association version when the association version was created.

Accessible with the following methods

Method	Description
GET_ASSOCIATIONNAME()	Getter for ASSOCIATIONNAME, with configurable default
ASK_ASSOCIATIONNAME()	Getter for ASSOCIATIONNAME w/ exceptions if field has no val
HAS_ASSOCIATIONNAME()	Determine if ASSOCIATIONNAME has a value

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

Accessible with the following methods

Method	Description
GET_MAXERRORS()	Getter for MAXERRORS, with configurable default
ASK_MAXERRORS()	Getter for MAXERRORS w/ exceptions if field has no value
HAS_MAXERRORS()	Determine if MAXERRORS has a value

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 MaxConcurrency associations, the association is allowed to run. During the next association interval, the new managed node will process its association within the limit specified for MaxConcurrency.

Accessible with the following methods

Method	Description
GET_MAXCONCURRENCY()	Getter for MAXCONCURRENCY, with configurable default
ASK_MAXCONCURRENCY()	Getter for MAXCONCURRENCY w/ exceptions if field has no valu
HAS_MAXCONCURRENCY()	Determine if MAXCONCURRENCY has a value

ComplianceSeverity

The severity level that is assigned to the association.

Accessible with the following methods

Method	Description
GET_COMPLIANCESEVERITY()	Getter for COMPLIANCESEVERITY, with configurable default
ASK_COMPLIANCESEVERITY()	Getter for COMPLIANCESEVERITY w/ exceptions if field has no
HAS_COMPLIANCESEVERITY()	Determine if COMPLIANCESEVERITY has a value

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 operation. In this case, compliance data isn't managed by State Manager, a tool in Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.

By default, all associations use AUTO mode.

Accessible with the following methods

Method	Description
GET_SYNCCOMPLIANCE()	Getter for SYNCCOMPLIANCE, with configurable default
ASK_SYNCCOMPLIANCE()	Getter for SYNCCOMPLIANCE w/ exceptions if field has no valu
HAS_SYNCCOMPLIANCE()	Determine if SYNCCOMPLIANCE has a value

ApplyOnlyAtCronInterval

By default, when you create 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.

Accessible with the following methods

Method	Description
GET_APPLYONLYATCRONINTERVAL()	Getter for APPLYONLYATCRONINTERVAL

CalendarNames

The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations for this version 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.

Accessible with the following methods

Method	Description
GET_CALENDARNAMES()	Getter for CALENDARNAMES, with configurable default
ASK_CALENDARNAMES()	Getter for CALENDARNAMES w/ exceptions if field has no value
HAS_CALENDARNAMES()	Determine if CALENDARNAMES has a value

TargetLocations

The combination of Amazon Web Services Regions and Amazon Web Services accounts where you wanted to run the association when this association version was created.

Accessible with the following methods

Method	Description
GET_TARGETLOCATIONS()	Getter for TARGETLOCATIONS, with configurable default
ASK_TARGETLOCATIONS()	Getter for TARGETLOCATIONS w/ exceptions if field has no val
HAS_TARGETLOCATIONS()	Determine if TARGETLOCATIONS has a value

ScheduleOffset

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

Accessible with the following methods

Method	Description
GET_SCHEDULEOFFSET()	Getter for SCHEDULEOFFSET, with configurable default
ASK_SCHEDULEOFFSET()	Getter for SCHEDULEOFFSET w/ exceptions if field has no valu
HAS_SCHEDULEOFFSET()	Determine if SCHEDULEOFFSET has a value

Duration

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.

Accessible with the following methods

Method	Description
GET_DURATION()	Getter for DURATION, with configurable default
ASK_DURATION()	Getter for DURATION w/ exceptions if field has no value
HAS_DURATION()	Determine if DURATION has a value

TargetMaps

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

Accessible with the following methods

Method	Description
GET_TARGETMAPS()	Getter for TARGETMAPS, with configurable default
ASK_TARGETMAPS()	Getter for TARGETMAPS w/ exceptions if field has no value
HAS_TARGETMAPS()	Determine if TARGETMAPS has a value

AssociationDispatchAssumeRole

A role used by association to take actions on your behalf. State Manager will assume this role and call required APIs when dispatching configurations to nodes. If not specified, service-linked role for Systems Manager will be used by default.

Accessible with the following methods

Method	Description
GET_ASSOCDISPATCHASSUMEROLE()	Getter for ASSOCDISPATCHASSUMEROLE, with configurable defaul
ASK_ASSOCDISPATCHASSUMEROLE()	Getter for ASSOCDISPATCHASSUMEROLE w/ exceptions if field ha
HAS_ASSOCDISPATCHASSUMEROLE()	Determine if ASSOCDISPATCHASSUMEROLE has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_ASSOCIATIONVERSIONLIST

TYPES TT_ASSOCIATIONVERSIONLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_SSMASSOCIATIONVRSINFO WITH DEFAULT KEY
.