Skip to content

Collector "AWS-DMS" Configuration Manual

Before reading this article, 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 be collected
regions[#] str Required Region ID. For example: 'cn-north-1'
See the full table in the appendix

2. Configuration Example

Collecting instance data from 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 {{( brand_name )}} 'Infrastructure - Resource Catalog'.

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
17
18
19
20
21
22
23
24
25
{
  "measurement": "aws_dms",
  "tags": {
    "AvailabilityZone"              : "cn-northwest-1b",
    "EngineVersion"                 : "3.5.1",
    "RegionId"                      : "cn-northwest-1",
    "ReplicationInstanceClass"      : "dms.t3.micro",
    "ReplicationInstanceIdentifier" : "hn-test",
    "ReplicationInstanceStatus"     : "available",
    "name"                          : "hn-test"
[]
  },
  "fields": {
    "AllocatedStorage"                   : 50,
    "AutoMinorVersionUpgrade"            : true,
    "InstanceCreateTime"                 : "2023-08-09T14:57:22.034000+08:00",
    "KmsKeyId"                           : "arn:aws-cn:kms:cn-northwest-1:",
    "MultiAZ"                            : false,
    "PreferredMaintenanceWindow"         : "tue:12",
    "PubliclyAccessible"                 : true,
    "ReplicationInstancePrivateIpAddress": "161.000.00.00",
    "ReplicationInstancePublicIpAddress" : "161.000.00.00",
    "message"                            : "{JSON instance data}"
  }
}

Fields in tags and fields may change with subsequent updates

4. IAM Policy Permissions

If users use IAM roles for resource collection, certain operation permissions need to be enabled

This collector requires the following permissions:

dms:DescribeReplicationInstances

X. Appendix

Please refer to the official AWS documentation: