AWS managedservices documentation change
Summary
Added formatting guidance for SSM document parameters, clarified supported automation documents with examples, and updated screenshot reference
Security assessment
Changes focus on parameter formatting and documentation clarity without addressing security vulnerabilities or introducing security features
Diff
diff --git a/managedservices/latest/userguide/tr-configure-remediations.md b/managedservices/latest/userguide/tr-configure-remediations.md index 7c7e7961e..d5567da08 100644 --- a//managedservices/latest/userguide/tr-configure-remediations.md +++ b//managedservices/latest/userguide/tr-configure-remediations.md @@ -31 +31 @@ The configurations for individual Trusted Advisor checks are stored as AWS AppCo - * **preconfigured-parameters:** Enter values for SSM document parameters that are required for automated remediation. + * **preconfigured-parameters:** Enter values for SSM document parameters that are required for automated remediation, in the format of `Parameter=Value` , separated by a comma (,). See [Trusted Advisor checks supported by Trusted Remediator](./tr-supported-checks.html) for supported preconfigured parameters for the associated SSM document for each check. @@ -33 +33 @@ The configurations for individual Trusted Advisor checks are stored as AWS AppCo - * **alternative-automation-document:** This attribute helps override the existing automation document with another supported document (if available for the specific check). By default, this attribute isn't selected. For information on supported checks and the automation documents, see [Trusted Advisor checks supported by Trusted Remediator](./tr-supported-checks.html) + * **alternative-automation-document:** This attribute helps override the existing automation document with another supported document (if available for the specific check). By default, this attribute isn't selected. @@ -37 +37,5 @@ The configurations for individual Trusted Advisor checks are stored as AWS AppCo -The `alternative-automation-document` attribute doesn't support custom automation documents. You can use existing supported Trusted Remediator automation documents. +The `alternative-automation-document` attribute doesn't support custom automation documents. You can use the existing supported Trusted Remediator automation documents listed in [Trusted Advisor checks supported by Trusted Remediator](./tr-supported-checks.html). + +For example, for check `Qch7DwouX1`, there are three associated SSM documents: AWSManagedServices-StopEC2Instance, AWSManagedServices-ResizeInstanceByOneLevel, and AWSManagedServices-TerminateInstance. The value for `alternative-automation-document` can be either AWSManagedServices-ResizeInstanceByOneLevel or AWSManagedServices-TerminateInstance (AWSManagedServices-StopEC2Instance is the default SSM document to remediate `Qch7DwouX1`). + +The value for each attribute must match the constraints of that attribute. @@ -46 +50 @@ Before you apply the default configurations for your Trusted Advisor checks, it' -The following is an example console screenshot with the **execution-mode** set to **Manual**. +The following is an example console screenshot with the **execution-mode** set to **Manual** and the attributes matching their constraints. @@ -48 +52 @@ The following is an example console screenshot with the **execution-mode** set t - +