AWS DB cluster discovery
-
- UpdatedJan 30, 2025
- 3 minutes to read
- Yokohama
- Service Mapping
ServiceNow Discovery uses the AWS DB cluster discovery pattern to find and map Aurora DB clusters, Aurora Serverless resources, Amazon Neptune DB instances, and Amazon DocumentDB instances. Discovering some of these resources requires updating the Discovery and Service Mapping Patterns application from the ServiceNow Store.
The discovered DB clusters form new relationships with the DB Instances discovered by the AWS Relational Database Service pattern. Therefore, the AWS DB cluster pattern is triggered after the AWS Relational Database Service pattern during discovery. For further information, see Amazon Relational Database Service (Amazon RDS) discovery.
Request apps on the Store
Visit the ServiceNow Store website to view all the available apps and for information about submitting requests to the store. For cumulative release notes information for all released apps, see the ServiceNow Store version history release notes.
Prerequisites
- Install the Discovery and Service Mapping Patterns application (version 1.0.75) from the ServiceNow Store.
- On the ServiceNow AI Platform, configure AWS credentials, using a secret key and an access key.
- Create a service account. Set the Account ID to the Amazon account ID to which RDS belongs. Use the Account ID as it appears in the AWS Management Console.
- Set read-only permissions for these REST APIs:
- https://rds.<REGION>.amazonaws.com/?Action=DescribeDBInstances
- https://rds.<REGION>.amazonaws.com/?Action=DescribeDBClusters
- https://rds.<REGION>.amazonaws.com/?Action=DescribeDBInstances&DBInstanceIdentifier=<input_object_id> for events discovery
- https://tagging.<REGION>.amazonaws.com/ for tags discovery
- For Cloud Discovery, download the Discovery and Service Mapping Patterns from the ServiceNow Store.
- When installing the MID Server, ensure that the host machine meets or exceeds the MID Server system requirements published on the ServiceNow documentation site.
Verify the REST API Permissions
Download the Cloud Discovery patterns spreadsheet so you can grant user permissions required for running the Discovery patterns. In addition to permissions, the spreadsheet also includes useful information such as pattern names, types, CI Classes, and links to vendor documentation. New patterns are available quarterly, so check periodically to be sure you have the latest version of the spreadsheet.
Data collected by Discovery during horizontal discovery
The discovered data includes the following tables and fields.
| Table and field | Description |
|---|---|
| Cloud Database Cluster [cmdb_ci_cloud_db_cluster] | |
| Cluster ID [cluster_id] | Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster. |
| Name [name] | Contains the name of the initial database of the DB cluster that was provided on creation. If a name was not specified, the cluster identifier is used as the name. This name is returned for the life of the DB cluster. |
| FQDN [fqdn] | Specifies the connection endpoint for the primary instance of the DB cluster. |
| TCP Port [tcp_port] | Port of the database endpoint. |
| Vendor [vendor] | The vendor, Amazon. |
| Cluster Status [cluster_status] | Specifies the current state of this DB cluster. |
| Operational Status [operational_status] | Status of the database, ”available” if operational. |
| Cloud Database [cmdb_ci_cloud_database] | |
| Object ID [object_id] | The instance identifier for this member of the DB cluster. Note: For Database
Instances, this table is populated with only the object_id attribute. This
attribute is required for identification of the Cloud Database CIs, to ensure
relationships between the CIs and the Cloud Database Clusters can be
made. |
| Name [name] | Contains the name of the initial database of the DB cluster that was provided on creation. If a name was not specified, the cluster identifier is used as the name. This name is returned for the life of the DB cluster. |
| FQDN [fqdn] | Specifies the connection endpoint for the primary instance of the DB cluster. |
| TCP Port [tcp_port] | Port of the database endpoint. |
| Vendor [vendor] | The vendor, Amazon. |
| Operational Status [operational_status] | Status of the database, ”available” if operational. |
| IP Address [cmdb_ci_ip_address] | |
| IP Address [ip_address] | IP address of the Cloud DB Cluster Writer endpoint. |
| Name [name] | The IP address. |
| Fully qualified domain name [fqdn] | Address of the database endpoint. The DNS name. |
| Netmask [netmask] | IP netmask [0.0.0.0]. |