/AWS1/CL_SSMTARGETLOCATION¶
The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation execution.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
it_accounts TYPE /AWS1/CL_SSMACCOUNTS_W=>TT_ACCOUNTS TT_ACCOUNTS¶
The Amazon Web Services accounts targeted by the current Automation execution.
it_regions TYPE /AWS1/CL_SSMREGIONS_W=>TT_REGIONS TT_REGIONS¶
The Amazon Web Services Regions targeted by the current Automation execution.
iv_targetlocmaxconcurrency TYPE /AWS1/SSMMAXCONCURRENCY /AWS1/SSMMAXCONCURRENCY¶
The maximum number of Amazon Web Services Regions and Amazon Web Services accounts allowed to run the Automation concurrently.
TargetLocationMaxConcurrencyhas a default value of 1.
iv_targetlocationmaxerrors TYPE /AWS1/SSMMAXERRORS /AWS1/SSMMAXERRORS¶
The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation.
TargetLocationMaxErrorshas a default value of 0.
iv_executionrolename TYPE /AWS1/SSMEXECUTIONROLENAME /AWS1/SSMEXECUTIONROLENAME¶
The Automation execution role used by the currently running Automation. If not specified, the default value is
AWS-SystemsManager-AutomationExecutionRole.
io_targetlocationalarmconf TYPE REF TO /AWS1/CL_SSMALARMCONFIGURATION /AWS1/CL_SSMALARMCONFIGURATION¶
TargetLocationAlarmConfiguration
iv_includechildorgunits TYPE /AWS1/SSMBOOLEAN /AWS1/SSMBOOLEAN¶
Indicates whether to include child organizational units (OUs) that are children of the targeted OUs. The default is
false.This parameter is not supported by State Manager.
it_excludeaccounts TYPE /AWS1/CL_SSMEXCLUDEACCOUNTS_W=>TT_EXCLUDEACCOUNTS TT_EXCLUDEACCOUNTS¶
Amazon Web Services accounts or organizational units to exclude as expanded targets.
it_targets TYPE /AWS1/CL_SSMTARGET=>TT_TARGETS TT_TARGETS¶
A list of key-value mappings to target resources. If you specify values for this data type, you must also specify a value for
TargetParameterName.This
Targetsparameter takes precedence over theStartAutomationExecution:Targetsparameter if both are supplied.
iv_targetsmaxconcurrency TYPE /AWS1/SSMMAXCONCURRENCY /AWS1/SSMMAXCONCURRENCY¶
The maximum number of targets allowed to run this task in parallel. This
TargetsMaxConcurrencytakes precedence over theStartAutomationExecution:MaxConcurrencyparameter if both are supplied.
iv_targetsmaxerrors TYPE /AWS1/SSMMAXERRORS /AWS1/SSMMAXERRORS¶
The maximum number of errors that are allowed before the system stops running the automation on additional targets. This
TargetsMaxErrorsparameter takes precedence over theStartAutomationExecution:MaxErrorsparameter if both are supplied.
Queryable Attributes¶
Accounts¶
The Amazon Web Services accounts targeted by the current Automation execution.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ACCOUNTS() |
Getter for ACCOUNTS, with configurable default |
ASK_ACCOUNTS() |
Getter for ACCOUNTS w/ exceptions if field has no value |
HAS_ACCOUNTS() |
Determine if ACCOUNTS has a value |
Regions¶
The Amazon Web Services Regions targeted by the current Automation execution.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_REGIONS() |
Getter for REGIONS, with configurable default |
ASK_REGIONS() |
Getter for REGIONS w/ exceptions if field has no value |
HAS_REGIONS() |
Determine if REGIONS has a value |
TargetLocationMaxConcurrency¶
The maximum number of Amazon Web Services Regions and Amazon Web Services accounts allowed to run the Automation concurrently.
TargetLocationMaxConcurrencyhas a default value of 1.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TARGETLOCMAXCONCURRENCY() |
Getter for TARGETLOCATIONMAXCONCURRENCY, with configurable d |
ASK_TARGETLOCMAXCONCURRENCY() |
Getter for TARGETLOCATIONMAXCONCURRENCY w/ exceptions if fie |
HAS_TARGETLOCMAXCONCURRENCY() |
Determine if TARGETLOCATIONMAXCONCURRENCY has a value |
TargetLocationMaxErrors¶
The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation.
TargetLocationMaxErrorshas a default value of 0.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TARGETLOCATIONMAXERRORS() |
Getter for TARGETLOCATIONMAXERRORS, with configurable defaul |
ASK_TARGETLOCATIONMAXERRORS() |
Getter for TARGETLOCATIONMAXERRORS w/ exceptions if field ha |
HAS_TARGETLOCATIONMAXERRORS() |
Determine if TARGETLOCATIONMAXERRORS has a value |
ExecutionRoleName¶
The Automation execution role used by the currently running Automation. If not specified, the default value is
AWS-SystemsManager-AutomationExecutionRole.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EXECUTIONROLENAME() |
Getter for EXECUTIONROLENAME, with configurable default |
ASK_EXECUTIONROLENAME() |
Getter for EXECUTIONROLENAME w/ exceptions if field has no v |
HAS_EXECUTIONROLENAME() |
Determine if EXECUTIONROLENAME has a value |
TargetLocationAlarmConfiguration¶
TargetLocationAlarmConfiguration
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TARGETLOCATIONALARMCONF() |
Getter for TARGETLOCATIONALARMCONF |
IncludeChildOrganizationUnits¶
Indicates whether to include child organizational units (OUs) that are children of the targeted OUs. The default is
false.This parameter is not supported by State Manager.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INCLUDECHILDORGUNITS() |
Getter for INCLUDECHILDORGUNITS |
ExcludeAccounts¶
Amazon Web Services accounts or organizational units to exclude as expanded targets.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EXCLUDEACCOUNTS() |
Getter for EXCLUDEACCOUNTS, with configurable default |
ASK_EXCLUDEACCOUNTS() |
Getter for EXCLUDEACCOUNTS w/ exceptions if field has no val |
HAS_EXCLUDEACCOUNTS() |
Determine if EXCLUDEACCOUNTS has a value |
Targets¶
A list of key-value mappings to target resources. If you specify values for this data type, you must also specify a value for
TargetParameterName.This
Targetsparameter takes precedence over theStartAutomationExecution:Targetsparameter if both are supplied.
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 |
TargetsMaxConcurrency¶
The maximum number of targets allowed to run this task in parallel. This
TargetsMaxConcurrencytakes precedence over theStartAutomationExecution:MaxConcurrencyparameter if both are supplied.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TARGETSMAXCONCURRENCY() |
Getter for TARGETSMAXCONCURRENCY, with configurable default |
ASK_TARGETSMAXCONCURRENCY() |
Getter for TARGETSMAXCONCURRENCY w/ exceptions if field has |
HAS_TARGETSMAXCONCURRENCY() |
Determine if TARGETSMAXCONCURRENCY has a value |
TargetsMaxErrors¶
The maximum number of errors that are allowed before the system stops running the automation on additional targets. This
TargetsMaxErrorsparameter takes precedence over theStartAutomationExecution:MaxErrorsparameter if both are supplied.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TARGETSMAXERRORS() |
Getter for TARGETSMAXERRORS, with configurable default |
ASK_TARGETSMAXERRORS() |
Getter for TARGETSMAXERRORS w/ exceptions if field has no va |
HAS_TARGETSMAXERRORS() |
Determine if TARGETSMAXERRORS 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_TARGETLOCATIONS¶
TYPES TT_TARGETLOCATIONS TYPE STANDARD TABLE OF REF TO /AWS1/CL_SSMTARGETLOCATION WITH DEFAULT KEY
.