Collector "AWS-S3" Configuration Manual¶

Before reading this document, please read:

Cloud Integration

Tip

Before using this collector, you must install the "Integration Core Package" and its accompanying third-party dependencies.

1. Configuration Structure¶

The configuration structure of this collector is as follows:

Field	Type	Required	Description
`regions`	list	Required	List of regions to be collected
`regions[#]`	str	Required	Region ID. For example: `'cn-north-1'` See appendix for the complete list

2. Configuration Example¶

Collect instance data from the Ningxia region

collector_configs = {
    'regions': [ 'cn-northwest-1' ]
}

3. Data Reporting Format¶

After data is successfully synchronized, you can view the data in the "Infrastructure - Resource Catalog" of TrueWatch.

An example of the reported data is as follows:

{
  "measurement": "aws_s3",
  "tags": {
    "name"              : "dataxxxx",
    "RegionId"          : "cn-northwest-1",
    "LocationConstraint": "cn-northwest-1",
    "Name"              : "dataxxxx"
  },
  "fields": {
    "CreationDate": "2022-03-09T06:13:31Z",
    "Grants"      : "{JSON data}",
    "message"     : "{Instance JSON data}"
  }
}

Note

The fields in tags and fields may change with subsequent updates.

Tip

The value of tags.name is the instance name, which serves as a unique identifier.

Tip

fields.message is a JSON serialized string.

Tip

fields.Grants is the bucket access control list.

4. IAM Policy Permissions¶

Note

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

This collector requires the following operation permissions:

s3:ListAllMyBuckets

s3:ListBucket

s3:GetBucketAcl

s3:GetBucketLocation

X. Appendix¶

Please refer to the AWS official documentation: