AWSConfigRemediation-UpdateAPIGatewayMethodCaching - Amazon Systems Manager Automation runbook reference
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).



The AWSConfigRemediation-UpdateAPIGatewayMethodCaching runbook updates the cache method setting for an Amazon API Gateway stage resource.

Run this Automation (console)

Document type





Linux, macOS, Windows


  • AutomationAssumeRole

    Type: String

    Allowed values: ^arn:(?:aws|aws-us-gov|aws-cn):iam::\d{12}:role\/[\w+=,.@/-]+$

    Description: (Required) The Amazon Resource Name (ARN) of the Amazon Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf.

  • CachingAuthorizedMethods

    Type: StringList

    Description: (Required) The methods authorized to have caching enabled. The list must be some combination of DELETE , GET , HEAD , OPTIONS , PATCH , POST , and PUT . Caching is enabled for selected methods and disabled for non-selected methods. Caching is enabled for all methods if ANY is selected and is disabled for all methods if NONE is selected.

  • StageArn

    Type: String

    Description: (Required) The API Gateway stage ARN for the REST API.

Required IAM permissions

The AutomationAssumeRole parameter requires the following actions to successfully use the runbook.

  • ssm:StartAutomationExecution

  • ssm:GetAutomationExecution

  • apigateway:PATCH

  • apigateway:GET

Document Steps

  • aws:executeScript - Accepts the stage resource ID as input, updates the cache method setting for an API Gateway stage using the UpdateStage API action, and verifies the update.