Amazon Launch Wizard Systems Manager Automation documents
A Systems Manager Automation document defines the actions that Systems Manager performs on your managed instances and other Amazon resources when an automation workflow runs. A document contains one or more steps that run in sequential order.
Launch Wizard provides predefined Automation documents that are maintained by Amazon. This topic describes each of the predefined Automation documents provided for Amazon Launch Wizard.
For more information about SSM Automation documents, see Amazon SSM Automation in the Amazon Systems Manager User Guide.
Launch Wizard-provided Automation documents:
AWSSQLServer-DBCC
The AWSSQLServer-DBCC
Automation document includes the steps to perform
database integrity checks on a specified database. You can control the type of database
checks that are run. You can also adjust the execution parameters, such as specific
tables to check, maximum CPU utilization, and more. For more information about the
operations performed by DBCC checks, see the SQL Server documentation
AWSSQLServer-Backup
The AWSSQLServer-Backup
Automation document includes the steps to back up
a specified database in either full, differential, or transactional mode. After the
backup is completed, you can upload it to a specified folder within an S3 bucket.
The backup modes are defined as follows:
-
Full — a complete backup of the database.
-
Differential — the delta of changes since the last full backup.
-
Transactional — a log of changes from the last full or differential backup, depending on the last backup type taken.
To help ensure that the AWSSQLServer-Backup
document can successfully
back up a database that resides on resources provisioned with Launch Wizard, make sure the
following is in place:
-
SQL Server was provisioned on a single node or with Always On availability groups (AG).
-
The
@@SERVERNAME
property in SQL Server matches the hostname of the operating system where the automation runs. -
The backup file is staged to a local disk.
-
The size of the backup file for uploading to an S3 bucket is 500 GB or less.
Required IAM actions that must be added to your IAM policy to successfully
run AWSSQLServer-Backup
:
s3:GetBucketPolicyStatus
s3:PutObject
For more information about backup modes, see the Microsoft documentation
AWSSQLServer-Index
The AWSSQLServer-Index
Automation document includes steps to perform
index maintenance operations on a specified database. You can choose a configuration,
which includes the specific actions to take based on the level of fragmentation.
For more information about index maintenance operations, see the Microsoft documentation
AWSSQLServer-Restore
The AWSSQLServer-Restore
Automation document includes steps to download a
backup database from a specified S3 bucket and folder to local storage. You can also
optionally restore the backup to a copy of the database. The default behavior is to use
the latest backup, and you can specify a time range to perform a point-in-time restore.
The following conditions must be met for the AWSSQLServer-Restore
document
to successfully restore a database:
-
The backup to use must have been performed by the
AWSSQLServer-Backup
document. -
There must be at least one full backup that occurred during the specified time range.
Required IAM actions that must be added to your IAM policy to successfully
run AWSSQLServer-Restore
:
s3:GetBucketPolicyStatus
s3:PutObject