/AWS1/CL_SMISSMAUTOMATION¶
Details about the Systems Manager automation document that will be used as a runbook during an incident.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_rolearn TYPE /AWS1/SMIROLEARN /AWS1/SMIROLEARN¶
The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.
iv_documentname TYPE /AWS1/SMISTRING /AWS1/SMISTRING¶
The automation document's name.
Optional arguments:¶
iv_documentversion TYPE /AWS1/SMISTRING /AWS1/SMISTRING¶
The automation document's version to use when running.
iv_targetaccount TYPE /AWS1/SMISSMTARGETACCOUNT /AWS1/SMISSMTARGETACCOUNT¶
The account that the automation document will be run in. This can be in either the management account or an application account.
it_parameters TYPE /AWS1/CL_SMISSMPARAMVALUES_W=>TT_SSMPARAMETERS TT_SSMPARAMETERS¶
The key-value pair parameters to use when running the automation document.
it_dynamicparameters TYPE /AWS1/CL_SMIDYNSSMPARAMVALUE=>TT_DYNAMICSSMPARAMETERS TT_DYNAMICSSMPARAMETERS¶
The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation runbook.
Queryable Attributes¶
roleArn¶
The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ROLEARN() |
Getter for ROLEARN, with configurable default |
ASK_ROLEARN() |
Getter for ROLEARN w/ exceptions if field has no value |
HAS_ROLEARN() |
Determine if ROLEARN has a value |
documentName¶
The automation document's name.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DOCUMENTNAME() |
Getter for DOCUMENTNAME, with configurable default |
ASK_DOCUMENTNAME() |
Getter for DOCUMENTNAME w/ exceptions if field has no value |
HAS_DOCUMENTNAME() |
Determine if DOCUMENTNAME has a value |
documentVersion¶
The automation document's version to use when running.
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 |
targetAccount¶
The account that the automation document will be run in. This can be in either the management account or an application account.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TARGETACCOUNT() |
Getter for TARGETACCOUNT, with configurable default |
ASK_TARGETACCOUNT() |
Getter for TARGETACCOUNT w/ exceptions if field has no value |
HAS_TARGETACCOUNT() |
Determine if TARGETACCOUNT has a value |
parameters¶
The key-value pair parameters to use when running the automation document.
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 |
dynamicParameters¶
The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation runbook.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DYNAMICPARAMETERS() |
Getter for DYNAMICPARAMETERS, with configurable default |
ASK_DYNAMICPARAMETERS() |
Getter for DYNAMICPARAMETERS w/ exceptions if field has no v |
HAS_DYNAMICPARAMETERS() |
Determine if DYNAMICPARAMETERS has a value |