Menu
AWS Ops Automator
AWS Ops Automator

Appendix A: Task-Configuration Templates

The AWS 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, as well as 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 <Requires Input> 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.
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, see Appendix C.

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.

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.

Cross account roles <Optional Input> Comma-delimited list of cross-account roles used by the task. For example, arn:aws:iam::111122223333:role/CreateSnaphotRole.

Note

Enter the secondary account CrossAccountRoleArn value(s) in this parameter. For customers who use a cross-account role ARN file, leave this parameter blank. For more information on the cross-account ARN file, see Appendix B

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

Amazon EC2 Create Snapshot Template

The create snapshot template enables the solution to automatically create snapshots of Amazon Elastic Block Store (Amazon EBS) volumes attached to Amazon Elastic Compute Cloud (Amazon EC2) instances.

Review the action-specific parameters for the template and modify them as necessary. This action template uses the following default values.

Parameter Default Description
Copy root volume Yes Create a snapshot of a root Amazon EC2 instance volume
Copy data volumes Yes Create snapshots of Amazon EC2 instance data volumes
Copied instance tags <Optional Input> Enter a tag filter to copy tags from the instance to the snapshot. For example, enter * to copy all tags from the instance to the snapshot. For more information on tag filters, see Appendix C.
Copied volume tags <Optional Input> Enter a tag filter to copy tags from the volume to the snapshot. For example, enter * to copy all tags from the volume to the snapshot. For more information on tag filters, see Appendix C.
Snapshot tags <Optional Input> Tags that will be added to snapshots. Use a list of tagname=tagvalue pairs. For example, if you create a task called DeleteEC2Snapshots, you can enter a value of OpsAutomatorTaskList=DeleteEC2Snapshots in this parameter to allow the AWS Ops Automator to delete the snapshot based on the parameters specified in the DeleteEC2Snapshots task.
Set snapshot name Yes Set the name of the snapshot
Snapshot name prefix <Optional Input> Prefix of the snapshot name

Amazon EC2 Delete Snapshot Template

The delete snapshot template enables the solution to automatically delete snapshots of Amazon Elastic Block Store (Amazon EBS) volumes attached to Amazon Elastic Compute Cloud (Amazon EC2) instances older than a customer-defined number of days. Or, customers can configure this action to keep only the latest snapshots.

Review the action-specific parameters for the template and modify them as necessary. This action template uses the following default values.

Parameter Default Description
Retention days <Requires Input> The retention period in days. Set this parameter to 0 to use Retention count.
Retention count <Requires Input> The number of snapshots to retain for a volume. Set this parameter to 0 to use Retention days.

Note

If both Retention days and Retention count are set to 0, the solution will return an error. You must specify only one.

Amazon EC2 Copy Snapshot Template

The copy snapshot template enables the solution to automatically copy snapshots of Amazon Elastic Block Store (Amazon EBS) volumes attached to Amazon Elastic Compute Cloud (Amazon EC2) instances from one AWS Region to another.

Review the action-specific parameters for the template and modify them as necessary. This action template uses the following default values.

Parameter Default Description
Copied tags <Optional Input> Enter a tag filter to copy tags from the source snapshot to the copied snapshot. For example, enter * to copy all tags from the source snapshot to the copied snapshot. For more information on tag filters, see Appendix C.
Snapshot tags <Optional Input> Tags to add to the copied snapshot. Use a list of tagname=tagvalue pairs.
Destination region <Optional Input> AWS Region to copy the snapshot to
Tagname for copied snapshots Ec2CopySnapshot:SnapshotCopied Tag to add to the copied snapshot to show that it was copied

Amazon Redshift Copy Snapshot Template

The Amazon Redshift copy snapshot template enables the solution to automatically copy snapshots of Amazon Redshift clusters from one AWS Region to another.

Review the action-specific parameters for the template and modify them as necessary. This action template uses the following default values.

Parameter Default Description
Copied cluster tags <Optional Input> Enter a tag filter to copy tags from the source snapshot to the copied snapshot. For example, enter * to copy all tags from the source snapshot to the copied snapshot. For more information on tag filters, see Appendix C.
Snapshot tags <Optional Input> Tags to add to snapshot. Use a list of tagname=tagvalue pairs. For example, if you create a task called DeleteRedShiftSnapshots, you can enter a value of OpsAutomatorTaskList=DeleteRedShiftSnapshots in this parameter to allow the AWS Ops Automator to delete the copied snapshot based on the parameters specified in the DeleteRedShiftSnapshots task.
Grant restore access to accounts <Optional Input> Comma-delimited list of accounts that can restore the snapshot. For example, 777788889999, 000000000000.
Tagname for copied snapshots Ec2CopySnapshot:SnapshotCopied Tag to add to the copied snapshot to show that it was copied

Amazon Redshift Delete Snapshot Template

The Amazon Redshift delete snapshot template enables the solution to automatically delete snapshots of Amazon Redshift clusters older than a customer-defined number of days. Or, customers can configure this action to keep only the latest snapshots.

Review the action-specific parameters for the template and modify them as necessary. This action template uses the following default values.

Parameter Default Description
Retention days <Requires Input> The retention period in days. Set this parameter to 0 to use Retention count.
Retention count <Requires Input> The number of snapshots to retain for a volume. Set this parameter to 0 to use Retention days.

Note

If both Retention days and Retention count are set to 0, the solution will return an error. You must specify only one.

Amazon DynamoDB Set Capacity Template

The Amazon DynamoDB set capacity template enables the solution to automatically provision throughput capacity for reads and writes to DynamoDB.

Review the action-specific parameters for the template and modify them as necessary. This action template uses the following default values.

Parameter Default Description
Table name <Requires Input> The name of the Amazon DynamoDB table
Table read units <Requires Input> The number of read units for the table
Table write units <Requires Input> The number of write units for the table

To set the capacity for global secondary indexes on the DynamoDB table, modify the applicable template parameters.

For more information on throughput capacity, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.