{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":29885,"path":"it-operations-management/discovery-and-service-mapping-patterns/aws-db-cluster-discovery.md","title":"Amazon DB cluster discovery with Patterns","bundle":null,"doc_type":null,"release":"australia","body":"\n# Amazon DB cluster discovery with Patterns\n\nServiceNow 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 might require updating to the latest version of the Discovery and Service Mapping Patterns application from the ServiceNow Store.\n\nThe 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 with Patterns](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-operations-management/discovery-and-service-mapping-patterns/aws-rds-discovery.md).\n\n## Request apps on the Store\n\nVisit the [ServiceNow Store](https://store.servicenow.com/sn_appstore_store.do#!/store/home) 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](https://www.servicenow.com/docs/r/store-release-notes/sn-store-release-notes.html).\n\n## Prerequisites\n\n- Install the Discovery and Service Mapping Patterns application \\(version 1.0.75\\) from the ServiceNow Store.\n- On the ServiceNow AI Platform, configure AWS credentials, using a secret key and an access key.\n- [Create a service account](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-operations-management/cloud-configuration-governance/aws-first-cld-and-srvc-accts.md). 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.\n- Set read-only permissions for these REST APIs:\n - https://rds.<REGION>.amazonaws.com/?Action=DescribeDBInstances\n - https://rds.<REGION>.amazonaws.com/?Action=DescribeDBClusters\n - https://rds.<REGION>.amazonaws.com/?Action=DescribeDBInstances&DBInstanceIdentifier=<input\\_object\\_id> for events discovery\n - https://tagging.<REGION>.amazonaws.com/ for tags discovery\n- For Cloud Discovery, download the Discovery and Service Mapping Patterns from the ServiceNow Store.\n- When installing the MID Server, ensure that the host machine meets or exceeds the [MID Server system requirements](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/servicenow-platform/r_MIDServerSystemRequirements.md) published on the ServiceNow documentation site.\n\n## Verify the REST API permissions\n\nDownload the [Cloud Discovery patterns spreadsheet](https://downloads.docs.servicenow.com/resource/enus/api/servicenow-discovery-patterns-api-details.xlsx) 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.\n\n**Note:** You can test the AWS REST APIs using Postman API platform. For more information, see the [How to test AWS REST API using POSTMAN \\[KB0782183\\]](https://support.servicenow.com/kb?id=kb_article_view&sysparm_article=KB0782183) article in the Now Support Knowledge Base.\n\n## Data collected by Discovery during horizontal discovery\n\nThe discovered data includes the following tables and fields.\n\n\n
\n\nTable and field\n\n\n\nDescription\n\n
\n\nCloud Database Cluster \\[cmdb\\_ci\\_cloud\\_db\\_cluster\\]\n\n
\n\nCluster ID \\[cluster\\_id\\]\n\n\n\nContains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.\n\n
\n\nName \\[name\\]\n\n\n\nContains 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.​\n\n
\n\nFQDN \\[fqdn\\]\n\n\n\nSpecifies the connection endpoint for the primary instance of the DB cluster.​\n\n
\n\nTCP Port \\[tcp\\_port\\]\n\n\n\nPort of the database endpoint.​\n\n
\n\nVendor \\[vendor\\]\n\n\n\nThe vendor, Amazon.\n\n
\n\nCluster Status \\[cluster\\_status\\]\n\n\n\nSpecifies the current state of this DB cluster.​\n\n
\n\nOperational Status \\[operational\\_status\\]\n\n\n\nStatus of the database, ”available” if operational.\n\n
\n\nCloud Database \\[cmdb\\_ci\\_cloud\\_database\\]\n\n
\n\nObject ID \\[object\\_id\\]\n\n\n\nThe 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.​\n\n
\n\nName \\[name\\]\n\n\n\nContains 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.​\n\n
\n\nFQDN \\[fqdn\\]\n\n\n\nSpecifies the connection endpoint for the primary instance of the DB cluster.​\n\n
\n\nTCP Port \\[tcp\\_port\\]\n\n\n\nPort of the database endpoint.\n\n
\n\nVendor \\[vendor\\]\n\n\n\nThe vendor, Amazon.\n\n
\n\nOperational Status \\[operational\\_status\\]\n\n\n\nStatus of the database, ”available” if operational.\n\n
\n\nIP Address \\[cmdb\\_ci\\_ip\\_address\\]\n\n
\n\nIP Address \\[ip\\_address\\]\n\n\n\nIP address of the Cloud DB Cluster Writer endpoint.\n\n
\n\nName \\[name\\]\n\n\n\nThe IP address.\n\n
\n\nFully qualified domain name \\[fqdn\\]\n\n\n\nAddress of the database endpoint. The DNS name.\n\n
\n\nNetmask \\[netmask\\]\n\n\n\nIP netmask \\[0.0.0.0\\].​\n\n
## CI relationships\n\n|CI|Relationship|CI|\n|---|------------|---|\n|cmdb\\_ci\\_cloud\\_db\\_cluster|Cluster off::Cluster​|cmdb\\_ci\\_cloud\\_database|\n|cmdb\\_ci\\_cloud\\_database​|Hosted on::Hosts​|cmdb\\_ci\\_aws\\_datacenter|\n|cmdb\\_ci\\_cloud\\_db\\_cluster​|Owns::Owned by​|cmdb\\_ci\\_ip\\_address​|\n|cmdb\\_ci\\_cloud\\_database|Owns::Owned by​|cmdb\\_ci\\_ip\\_address​|\n|cmdb\\_key\\_value|Reference only​|cmdb\\_ci\\_cloud\\_db\\_cluster​|\n|cmdb\\_key\\_value|Reference only​|cmdb\\_ci\\_cloud\\_database|\n\n**Parent Topic:**[AWS discovery using patterns](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-operations-management/discovery-and-service-mapping-patterns/data-discovered-aws-patterns.md)\n\n"}}