Product logo
DocsBlogPricing

@turbot/aws-apigateway

The aws-apigateway mod contains resource, control and policy definitions for AWS API Gateway service.

Version
5.8.0
Released On
Oct 04, 2023
Depends On

Resource Types

Control Types

Policy Types

Release Notes

5.8.0 (2023-10-04)

What's new?

  • We've updated the runtime of the lambda functions to Node 18. You wouldn't notice any difference and things will continue to work smoothly and consistently as before.

  • Users can now perform quick actions on resources to remediate cloud configuration issues or skip Turbot alarms for issues that they want to come back to later. To get started, click on the Actions button, which will reveal a dropdown menu with available actions, and select one. See Quick Actions for more information.

  • Resource's metadata will now also include createdBy details in Turbot CMDB.

Action Types

Added

  • AWS > API Gateway > API > Delete from AWS
  • AWS > API Gateway > API > Set Tags
  • AWS > API Gateway > API > Skip alarm for Active control
  • AWS > API Gateway > API > Skip alarm for Active control [90 days]
  • AWS > API Gateway > API > Skip alarm for Approved control
  • AWS > API Gateway > API > Skip alarm for Approved control [90 days]
  • AWS > API Gateway > API > Skip alarm for Tags control
  • AWS > API Gateway > API > Skip alarm for Tags control [90 days]
  • AWS > API Gateway > API Key > Delete from AWS
  • AWS > API Gateway > API Key > Set Tags
  • AWS > API Gateway > API Key > Skip alarm for Active control
  • AWS > API Gateway > API Key > Skip alarm for Active control [90 days]
  • AWS > API Gateway > API Key > Skip alarm for Approved control
  • AWS > API Gateway > API Key > Skip alarm for Approved control [90 days]
  • AWS > API Gateway > API Key > Skip alarm for Tags control
  • AWS > API Gateway > API Key > Skip alarm for Tags control [90 days]
  • AWS > API Gateway > API V2 > Delete from AWS
  • AWS > API Gateway > API V2 > Set Tags
  • AWS > API Gateway > API V2 > Skip alarm for Active control
  • AWS > API Gateway > API V2 > Skip alarm for Active control [90 days]
  • AWS > API Gateway > API V2 > Skip alarm for Approved control
  • AWS > API Gateway > API V2 > Skip alarm for Approved control [90 days]
  • AWS > API Gateway > API V2 > Skip alarm for Tags control
  • AWS > API Gateway > API V2 > Skip alarm for Tags control [90 days]
  • AWS > API Gateway > Authorizer > Delete from AWS
  • AWS > API Gateway > Authorizer > Skip alarm for Active control
  • AWS > API Gateway > Authorizer > Skip alarm for Active control [90 days]
  • AWS > API Gateway > Authorizer > Skip alarm for Approved control
  • AWS > API Gateway > Authorizer > Skip alarm for Approved control [90 days]
  • AWS > API Gateway > Authorizer V2 > Delete from AWS
  • AWS > API Gateway > Authorizer V2 > Skip alarm for Active control
  • AWS > API Gateway > Authorizer V2 > Skip alarm for Active control [90 days]
  • AWS > API Gateway > Authorizer V2 > Skip alarm for Approved control
  • AWS > API Gateway > Authorizer V2 > Skip alarm for Approved control [90 days]
  • AWS > API Gateway > Domain Name V2 > Delete from AWS
  • AWS > API Gateway > Domain Name V2 > Set Tags
  • AWS > API Gateway > Domain Name V2 > Skip alarm for Active control
  • AWS > API Gateway > Domain Name V2 > Skip alarm for Active control [90 days]
  • AWS > API Gateway > Domain Name V2 > Skip alarm for Approved control
  • AWS > API Gateway > Domain Name V2 > Skip alarm for Approved control [90 days]
  • AWS > API Gateway > Domain Name V2 > Skip alarm for Tags control
  • AWS > API Gateway > Domain Name V2 > Skip alarm for Tags control [90 days]
  • AWS > API Gateway > Integration V2 > Delete from AWS
  • AWS > API Gateway > Integration V2 > Skip alarm for Active control
  • AWS > API Gateway > Integration V2 > Skip alarm for Active control [90 days]
  • AWS > API Gateway > Integration V2 > Skip alarm for Approved control
  • AWS > API Gateway > Integration V2 > Skip alarm for Approved control [90 days]
  • AWS > API Gateway > Resource > Delete from AWS
  • AWS > API Gateway > Resource > Skip alarm for Active control
  • AWS > API Gateway > Resource > Skip alarm for Active control [90 days]
  • AWS > API Gateway > Resource > Skip alarm for Approved control
  • AWS > API Gateway > Resource > Skip alarm for Approved control [90 days]
  • AWS > API Gateway > Stage > Delete from AWS
  • AWS > API Gateway > Stage > Set Tags
  • AWS > API Gateway > Stage > Skip alarm for Active control
  • AWS > API Gateway > Stage > Skip alarm for Active control [90 days]
  • AWS > API Gateway > Stage > Skip alarm for Approved control
  • AWS > API Gateway > Stage > Skip alarm for Approved control [90 days]
  • AWS > API Gateway > Stage > Skip alarm for Tags control
  • AWS > API Gateway > Stage > Skip alarm for Tags control [90 days]
  • AWS > API Gateway > Stage v2 > Delete from AWS
  • AWS > API Gateway > Stage v2 > Set Tags
  • AWS > API Gateway > Stage v2 > Skip alarm for Active control
  • AWS > API Gateway > Stage v2 > Skip alarm for Active control [90 days]
  • AWS > API Gateway > Stage v2 > Skip alarm for Approved control
  • AWS > API Gateway > Stage v2 > Skip alarm for Approved control [90 days]
  • AWS > API Gateway > Stage v2 > Skip alarm for Tags control
  • AWS > API Gateway > Stage v2 > Skip alarm for Tags control [90 days]
  • AWS > API Gateway > Usage Plan > Delete from AWS
  • AWS > API Gateway > Usage Plan > Set Tags
  • AWS > API Gateway > Usage Plan > Skip alarm for Active control
  • AWS > API Gateway > Usage Plan > Skip alarm for Active control [90 days]
  • AWS > API Gateway > Usage Plan > Skip alarm for Approved control
  • AWS > API Gateway > Usage Plan > Skip alarm for Approved control [90 days]
  • AWS > API Gateway > Usage Plan > Skip alarm for Tags control
  • AWS > API Gateway > Usage Plan > Skip alarm for Tags control [90 days]

5.7.0 (2022-02-14)

What's new?

  • Users can now create their own custom checks against resource attributes in the Approved control using the Approved > Custom policy. These custom checks would be a part of the evaluation of the Approved control. Custom messages can also be added which are then displayed in the control details table. See Custom Checks for more information.

Bug fixes

  • The AWS > API Gateway > Resource > CMDB now includes Authorization and API Key metadata and automatically detects and updates the CMDB data when changes are made to its Methods and Integrations.
  • We've improved the process of deleting resources from Turbot if their CMDB policy was set to Enforce: Disabled. The CMDB controls will now not look to resolve credentials via Turbot's IAM role while deleting resources from Turbot. This will allow the CMDB controls to process resource deletions from Turbot more reliably than before.

Policy Types

Added

  • AWS > API Gateway > API > Approved > Custom
  • AWS > API Gateway > API Key > Approved > Custom
  • AWS > API Gateway > API V2 > Approved > Custom
  • AWS > API Gateway > Authorizer > Approved > Custom
  • AWS > API Gateway > Authorizer V2 > Approved > Custom
  • AWS > API Gateway > Domain Name V2 > Approved > Custom
  • AWS > API Gateway > Integration V2 > Approved > Custom
  • AWS > API Gateway > Resource > Approved > Custom
  • AWS > API Gateway > Stage > Approved > Custom
  • AWS > API Gateway > Stage v2 > Approved > Custom
  • AWS > API Gateway > Usage Plan > Approved > Custom

5.6.0 (2021-12-17)

Resource Types

Added

  • AWS > API Gateway > Resource

Control Types

Added

  • AWS > API Gateway > Resource > Active
  • AWS > API Gateway > Resource > Approved
  • AWS > API Gateway > Resource > CMDB
  • AWS > API Gateway > Resource > Discovery
  • AWS > API Gateway > Resource > Usage

Policy Types

Added

  • AWS > API Gateway > Resource > Active
  • AWS > API Gateway > Resource > Active > Age
  • AWS > API Gateway > Resource > Active > Last Modified
  • AWS > API Gateway > Resource > Approved
  • AWS > API Gateway > Resource > Approved > Regions
  • AWS > API Gateway > Resource > Approved > Usage
  • AWS > API Gateway > Resource > CMDB
  • AWS > API Gateway > Resource > Regions
  • AWS > API Gateway > Resource > Usage
  • AWS > API Gateway > Resource > Usage > Limit

Action Types

Added

  • AWS > API Gateway > Resource > Delete
  • AWS > API Gateway > Resource > Router

5.5.0 (2021-11-25)

What's new?

  • We've improved the details tables in the Tags controls to be more helpful, especially when a resource's tags are not set correctly as expected. Previously, to understand why the Tags controls were in an Alarm state, you would need to find and read the control's process logs. This felt like too much work for a simple task, so now these details are visible directly from the control page.

Resource Types

Added

  • AWS > API Gateway > Integration V2

Control Types

Added

  • AWS > API Gateway > Integration V2 > Active
  • AWS > API Gateway > Integration V2 > Approved
  • AWS > API Gateway > Integration V2 > CMDB
  • AWS > API Gateway > Integration V2 > Discovery
  • AWS > API Gateway > Integration V2 > Usage

Policy Types

Added

  • AWS > API Gateway > Integration V2 > Active
  • AWS > API Gateway > Integration V2 > Active > Age
  • AWS > API Gateway > Integration V2 > Active > Last Modified
  • AWS > API Gateway > Integration V2 > Approved
  • AWS > API Gateway > Integration V2 > Approved > Regions
  • AWS > API Gateway > Integration V2 > Approved > Usage
  • AWS > API Gateway > Integration V2 > CMDB
  • AWS > API Gateway > Integration V2 > Regions
  • AWS > API Gateway > Integration V2 > Usage
  • AWS > API Gateway > Integration V2 > Usage > Limit

Action Types

Added

  • AWS > API Gateway > Integration V2 > Delete
  • AWS > API Gateway > Integration V2 > Router

5.4.0 (2021-02-24)

What's new?

  • We've improved the state reasons and details tables in various Approved and Active controls to be more helpful, especially when a resource is unapproved or inactive. Previously, to understand why one of these controls is in Alarm state, you would need to find and read the control's process logs. This felt like too much work for a simple task, so now these details are visible directly from the control page.

Bug fixes

  • The policy data for api resources are now properly formatted into the json format.

5.3.3 (2020-12-21)

Bug fixes

  • Rest APIs and HTTP APIs created via import in AWS were not upserted automatically into Turbot’s CMDB. This is now fixed and they will now be upserted as AWS > API Gateway > API and AWS > API Gateway > API V2 resources respectively.

  • Controls run faster now when in the tbd and skipped states thanks to the new Turbot Precheck feature (not to be confused with TSA PreCheck). With Turbot Precheck, controls avoid running GraphQL input queries when in tbd and skipped, resulting in faster and lighter control runs.

5.3.2 (2020-10-12)

Bug fixes

  • Whenever a domain name was created, we would mishandle these events and create a domain name in CMDB without its identifier in its AKA. This issue has been fixed and we now create domain names with the proper AKAs. Domain names that were created with malformed AKAs can automatically be cleaned up by the AWS > Account > Resource AKA Cleanup control, which is available in aws (5.13.0) and later.

5.3.1 (2020-09-18)

Bug fixes

  • We've made some improvements to our real-time event handling that reduces the risk of creating resources in CMDB with malformed AKAs. There's no noticeable difference, but things should run more reliably now.

5.3.0 (2020-09-01)

What's new?

  • Discovery controls now have their own control category, CMDB > Discovery, to allow for easier filtering separately from other CMDB controls.
  • We've renamed the service's default regions policy from Regions [Default] to Regions to be consistent with our other regions policies.

5.2.1 (2020-08-11)

Bug fixes

  • In various Active controls, we were outputting log messages that did not properly show how many days were left until we'd delete the inactive resources (we were still deleting them after the correct number of days). These log messages have been fixed and now contain the correct number of days.

5.2.0 (2020-07-08)

Bug fixes

  • Updated various resource configurations to provide better compatibility with AWS China regions.
  • The AWS > API Gateway > Domain Name resource type, along with all of its controls, policies, and actions have been removed. This resource type was a duplicate of the AWS > API Gateway > Domain Name V2 resource type and would often cause control errors for domain name resources, as they shared the same AKA format which caused a conflict.

Resource Types

Removed

  • AWS > API Gateway > Domain Name

Control Types

Removed

  • AWS > API Gateway > Domain Name > Active
  • AWS > API Gateway > Domain Name > Approved
  • AWS > API Gateway > Domain Name > CMDB
  • AWS > API Gateway > Domain Name > Discovery
  • AWS > API Gateway > Domain Name > Tags
  • AWS > API Gateway > Domain Name > Usage

Policy Types

Removed

  • AWS > API Gateway > Domain Name > Active
  • AWS > API Gateway > Domain Name > Active > Age
  • AWS > API Gateway > Domain Name > Active > Last Modified
  • AWS > API Gateway > Domain Name > Approved
  • AWS > API Gateway > Domain Name > Approved > Regions
  • AWS > API Gateway > Domain Name > Approved > Usage
  • AWS > API Gateway > Domain Name > CMDB
  • AWS > API Gateway > Domain Name > Regions
  • AWS > API Gateway > Domain Name > Tags
  • AWS > API Gateway > Domain Name > Tags > Template
  • AWS > API Gateway > Domain Name > Usage
  • AWS > API Gateway > Domain Name > Usage > Limit

Action Types

Removed

  • AWS > API Gateway > Domain Name > Delete
  • AWS > API Gateway > Domain Name > Router
  • AWS > API Gateway > Domain Name > Update Tags

5.1.2 (2020-05-20)

Bug fixes

  • After creating, updating or deleting API Gateway resources, Turbot failed to automatically pick up these events, so these resources were not being updated in CMDB. This issue has been fixed and now you no longer need to run the Discovery and CMDB controls to keep the resources updated.

5.1.1 (2020-05-14)

Bug fixes

  • Links to documentation in the descriptions for several controls and policies were broken. These links have now been fixed.