Skip to content

Collector "AWS-GateWay" Configuration Manual

Before reading this, please first read:

Before using this collector, you must install the «Integration Core Package» and its associated third-party dependency packages

1. Configuration Structure

The configuration structure of this collector is as follows:

Field Type Required Description
regions list Required List of regions to collect data from
regions[#] str Required Region ID. For example: 'cn-north-1'
Refer to the appendix for the full list

2. Configuration Example

Collecting instance data from Ningxia and Beijing regions

Python
1
2
3
collector_configs = {
    'regions': [ 'cn-northwest-1', 'cn-north-1' ]
}

3. Data Reporting Format

After the data has been successfully synchronized, it can be viewed in the «Infrastructure - Resource Catalog» section of {{( brand_name }}}.

An example of the reported data is as follows:

JSON
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "measurement": "aws_gateway",
  "tags": {
    "name"                 : "c72z3thtqxx",
    "ApiId"                : "c72z3thtqxx",
    "ProtocolType"         : "HTTP",
    "Version"              : "active",
    "api_name"             : "helloworld",
  },
  "fields": {
    "CreatedDate"              : "2022-03-09T06:13:31Z",
    "ApiKeySelectionExpression": "$request.header.",
    "DisableSchemaValidation"  : "xxxxx",
    "Description"              : "Created by AWS Lambda"
  }
}

Fields in tags and fields may change with subsequent updates

4. IAM Policy Permissions

If users use IAM roles to collect resources, certain operation permissions need to be enabled

This collector requires the following operation permissions:

apigateway:GET

X. Appendix

Please refer to the official AWS documentation: