Appendix A: Task-configuration templates - Ops Automator

Appendix A: Task-configuration templates

Ops Automator automatically generates a separate AWS CloudFormation template for each action. Review the template parameters and modify them as necessary.

Common template parameters

Each action-specific template has a set of common parameters, and a set of parameters that are specific to the applicable action. Review the common parameters and modify them as necessary.

Parameter Default Description
Task Description <Optional Input> Description of the task. For example, Create a snapshot every 30 minutes.
Task interval <Optional Input>

For tasks that support intervals, enter the scheduled expression (cron syntax) that specifies when to run the task. For example, enter 0/30 * * * * to run the task every 30 minutes.

Note

Some tasks have a constraint on the minimum time between executions. When you create the task, the cron expression will be validated against that restraint. If the expression is not valid, the stack will not create and an error message will be logged.

Tag filter <Optional Input> Filter used to select resources. You can use this instead of adding the task name to the list of values in the OpsAutomatorTaskList tag. For example, Owner=DBAdmin, Stack=Test. For more information on tag filters, refer to Appendix D.
Note

For actions that can delete or terminate resources, you cannot use “*” as the name of the tag in the filter.

Timeout 60 The number of minutes the solution waits for a task to complete before reporting timing out. Specify a value of at least 1 minute. Ops Automator will continue to check for task completion until the timeout is reached, then emit a Timeout error if it has not completed.
Note

This parameter will only show for actions that the solution checks for completion.

Regions <Default region> List of Regions where the task will run. For example, us-east-1, eu-west-1.
Note

Use this parameter for actions that use regional resources. This parameter will not show for actions that use global resources. For example, IAM and Amazon S3.

This account Yes Select Yes to allow the task to select resources in this account.
Note

If you set this parameter to No, you must configure cross-account roles. For more information, refer to Role Configuration.

Accounts <Optional Input> Comma-delimited list of account roles used by the task.
Note

To allow cross-account operations, a cross-account role must be created. For more information, refer to Role Configuration.

Cross account role name <Optional Input> The name of a cross-account role that allows accounts to run this task. Leave this parameter blank to use the default role (<ops-automator-stackname>-OpsAutomatorActionsRole). For more information, refer to Role Configuration.
Timezone UTC The time zone used for scheduling the task.
Task enabled Yes Select No to temporarily disable execution of the task.
Enable debugging No Choose whether to log detailed debugging information.
Resource selection scope for <eventname> event resource Choose the scope for selecting resources for tasks triggered by an event. Select resource or region.
Collect Metrics No Choose whether to collect CloudWatch metrics for the task.
Task Notifications No Choose whether to send notifications for started/ended tasks to an Amazon SNS topic.

Task memory allocation settings

Some actions include parameters that enable you to select larger AWS Lambda functions to run specific steps of a task. Review the memory allocation parameters and modify them as necessary.

Parameter Default Description
Resource selection memory Standard or action-specific default The memory size of the Lambda function that selects resources. Set this parameter to a higher value if you expect to select a large number of resources or you expect the selection of resources to take more than the 15-minute Lambda timeout or task interval. Choose Standard, Medium, Large, XLarge, XXLarge, or XXXLarge. If you selected Fargate when you installed Ops Automator then Amazon ECS will allow you to choose Fargate for this action.
Selection reserved memory (if Resource selection memory = ECS) 128 Reserved memory (MB) to select resources for the task using an ECS task in a Fargate container. This value is only used if ECS is selected as the value for the Resource selection memory parameter. Specify a value between 4 and 8192 MB. Increase this value if resource selection is running out of memory.
Execution memory Standard or action-specific default

The memory size of the Lambda function that runs the completion check. Set this parameter to a higher value if you expect the completion check to take more than the 15-minute Lambda timeout or task interval. Choose Standard, Medium, Large, XLarge, XXLarge, or XXXLarge.

Execution reserved memory (if Execution Memory = ECS) 128

Reserved memory (MB) for task execution using an ECS task in a Fargate container. This value is only used if ECS is selected as the value for the Execution memory parameter. Specify a value between 4 and 8192MB. Increase this value if your task is running out of memory.

Amazon EBS snapshot events

The following parameters are for actions that can be triggered by Amazon Elastic Block Store (Amazon EBS) snapshot events.

Parameter Default Description
Snapshot copied No Choose whether to run the EBS snapshot targeted task when the snapshot is copied.
Snapshot for volume copied No Choose whether to run the EBS volume targeted task when the volume is copied.
Snapshot created No Choose whether to run the EBS snapshot targeted task when the snapshot is created.
Snapshot for volume created No Choose whether to run the EBS volume targeted task when the volume is created.
Snapshot shared account No Choose whether to run the EBS snapshot targeted task when a snapshot is shared with the task account.

Amazon EC2 state events

The following parameters are for actions that can be triggered by specific Amazon Elastic Compute Cloud (Amazon EC2) state events.

Parameter Default Description
Instance started No Choose whether to run a task when an Amazon EC2 instance is started.
Instance stopped No Choose whether to run a task when an Amazon EC2 instance is stopped.
Instance terminated No Choose whether to run a task when an Amazon EC2 instance is terminated.

Amazon EC2 tag events

The following parameters are for actions that can be triggered by specific Amazon EC2 tag events.

Parameter Default Description
EC2 Tag Change Events No Choose whether to run a task when Amazon EC2 instance tags are modified.
EBS Snapshot Events No Choose whether to run a task when Amazon EBS snapshot tags are modified.