AWS systems-manager-automation-runbooks documentation change
Summary
Updated documentation to replace 'AWS CloudFormation' with 'CloudFormation' throughout the file for terminology consistency
Security assessment
The changes are purely terminological adjustments to align with AWS service naming conventions. No security-related content was added, modified, or removed. The existing security context around IAM policies, Secrets Manager integration, and resource cleanup remains unchanged.
Diff
diff --git a/systems-manager-automation-runbooks/latest/userguide/automation-aws-postgresqlworkloadreview.md b/systems-manager-automation-runbooks/latest/userguide/automation-aws-postgresqlworkloadreview.md index c3f90579e..925702a46 100644 --- a//systems-manager-automation-runbooks/latest/userguide/automation-aws-postgresqlworkloadreview.md +++ b//systems-manager-automation-runbooks/latest/userguide/automation-aws-postgresqlworkloadreview.md @@ -11 +11 @@ The `AWSPremiumSupport-PostgreSQLWorkloadReview` runbook captures multiple snaps -This runbook automatically creates the following AWS resources in your AWS account using an AWS CloudFormation stack. You can monitor the stack creation using the AWS CloudFormation console. +This runbook automatically creates the following AWS resources in your AWS account using an AWS CloudFormation stack. You can monitor the stack creation using the CloudFormation console. @@ -26 +26 @@ This runbook automatically creates the following AWS resources in your AWS accou -When the runbook completes, the AWS CloudFormation stack that is used to create the necessary AWS resources is deleted and the report is uploaded to the Amazon S3 bucket of your choice, and optionally an Support case. +When the runbook completes, the CloudFormation stack that is used to create the necessary AWS resources is deleted and the report is uploaded to the Amazon S3 bucket of your choice, and optionally an Support case. @@ -234 +234 @@ Type: String -Description: (Required) The ARN of your Secrets Manager secret containing the username and password key value pair. The AWS CloudFormation stack creates an IAM policy with permissions for the `GetSecretValue` operation to this ARN. The credentials are used to allow the temporary instance to collect the database statistics. Contact your TAM or STAM to discuss the minimum required permissions. +Description: (Required) The ARN of your Secrets Manager secret containing the username and password key value pair. The CloudFormation stack creates an IAM policy with permissions for the `GetSecretValue` operation to this ARN. The credentials are used to allow the temporary instance to collect the database statistics. Contact your TAM or STAM to discuss the minimum required permissions. @@ -276 +276 @@ Type: String -Description: (Optional) The AWS CloudFormation stack resources name prefix and tag. The runbook creates the AWS CloudFormation stack resources using this prefix as part of the name and tag applied to the resources. The structure for the tag key-value pair is ``StackResourcesNamePrefix`:{{automation:EXECUTION_ID}}`. +Description: (Optional) The CloudFormation stack resources name prefix and tag. The runbook creates the CloudFormation stack resources using this prefix as part of the name and tag applied to the resources. The structure for the tag key-value pair is ``StackResourcesNamePrefix`:{{automation:EXECUTION_ID}}`. @@ -334 +334 @@ Type: String -Description: (Optional) If set to `true`, the temporary Amazon EC2 instance's root volume is deleted after the runbook completes and deletes the AWS CloudFormation stack. +Description: (Optional) If set to `true`, the temporary Amazon EC2 instance's root volume is deleted after the runbook completes and deletes the CloudFormation stack. @@ -570 +570 @@ The `AutomationAssumeRole` parameter requires the following actions to use the r - 4. `aws:executeScript` \- Gets the AWS CloudFormation template content from the Automation runbook attachment that is used to create the temporary AWS resources in your AWS account. + 4. `aws:executeScript` \- Gets the CloudFormation template content from the Automation runbook attachment that is used to create the temporary AWS resources in your AWS account. @@ -572 +572 @@ The `AutomationAssumeRole` parameter requires the following actions to use the r - 5. `aws:createStack` \- Creates the AWS CloudFormation stack resources. + 5. `aws:createStack` \- Creates the CloudFormation stack resources. @@ -574 +574 @@ The `AutomationAssumeRole` parameter requires the following actions to use the r - 6. `aws:waitForAwsResourceProperty` \- Waits until the Amazon EC2 instance created by the AWS CloudFormation template is running. + 6. `aws:waitForAwsResourceProperty` \- Waits until the Amazon EC2 instance created by the CloudFormation template is running. @@ -576 +576 @@ The `AutomationAssumeRole` parameter requires the following actions to use the r - 7. `aws:executeAwsApi` \- Gets the IDs for the temporary Amazon EC2 instance and VPC peering connection created by AWS CloudFormation. + 7. `aws:executeAwsApi` \- Gets the IDs for the temporary Amazon EC2 instance and VPC peering connection created by CloudFormation. @@ -596 +596 @@ The `AutomationAssumeRole` parameter requires the following actions to use the r - 15. `aws:waitForAwsResourceProperty` \- Waits until the maintenance window created by the AWS CloudFormation template is ready. + 15. `aws:waitForAwsResourceProperty` \- Waits until the maintenance window created by the CloudFormation template is ready. @@ -598 +598 @@ The `AutomationAssumeRole` parameter requires the following actions to use the r - 16. `aws:executeAwsApi` \- Gets the IDs for the maintenance window and change calendar created by AWS CloudFormation. + 16. `aws:executeAwsApi` \- Gets the IDs for the maintenance window and change calendar created by CloudFormation. @@ -620 +620 @@ The `AutomationAssumeRole` parameter requires the following actions to use the r - 22. `aws:changeInstanceState` \- Stops the temporary Amazon EC2 instance in case the AWS CloudFormation stack fails to delete. + 22. `aws:changeInstanceState` \- Stops the temporary Amazon EC2 instance in case the CloudFormation stack fails to delete. @@ -622 +622 @@ The `AutomationAssumeRole` parameter requires the following actions to use the r - 23. `aws:executeAwsApi` \- Describes the AWS CloudFormation stack events if the runbooks fails to create or update the AWS CloudFormation stack. + 23. `aws:executeAwsApi` \- Describes the CloudFormation stack events if the runbooks fails to create or update the CloudFormation stack. @@ -624 +624 @@ The `AutomationAssumeRole` parameter requires the following actions to use the r - 24. `aws:waitForAwsResourceProperty` \- Waits until the AWS CloudFormation stack is in a terminal status before deleting. + 24. `aws:waitForAwsResourceProperty` \- Waits until the CloudFormation stack is in a terminal status before deleting. @@ -626 +626 @@ The `AutomationAssumeRole` parameter requires the following actions to use the r - 25. `aws:executeAwsApi` \- Deletes the AWS CloudFormation stack excluding the maintenance window. The root Amazon EBS volume associated with the temporary Amazon EC2 instance is preserved if the `EbsVolumeDeleteOnTermination` parameter value was set to `false`. + 25. `aws:executeAwsApi` \- Deletes the CloudFormation stack excluding the maintenance window. The root Amazon EBS volume associated with the temporary Amazon EC2 instance is preserved if the `EbsVolumeDeleteOnTermination` parameter value was set to `false`.