Skip to content

Collector Configuration Manual for «AWS-AppSync»

Before reading this article, please read the following first:

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. Example: 'cn-north-1'
See full table in the appendix

2. Configuration Example

Collect instance data for the Beijing region.

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

3. Data Reporting Format

After data synchronization is successful, you can view the data 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
{
  "measurement": "aws_appsync",
  "tags": {
    "name"                 : "7kkbwnojrjhcpdwqhxyz5uvzum",
    "apiId"                : "7kkbwnojrjhcpdwqhxyz5uvzum",
    "arn"                  : "HTTP",
    "authenticationType"   : "API_KEY",
    "api_name"             : "helloworld",
  },
  "fields": {
    "uris"                 : "{URI JSON data}",
    "message"              : "{Instance JSON data}"
  }
}

Fields in tags and fields may change with subsequent updates

4. IAM Policy Permissions

If users collect resources by assuming an IAM role, certain operation permissions need to be enabled

This collector requires the following operation permissions:

appsync:ListGraphqlApis

X. Appendix

Refer to the official AWS documentation: