AWS DMS Endpoints pattern-based discovery
Summarize
Summary of AWS DMS Endpoints pattern-based discovery
The AWS DMS Endpoints pattern-based discovery feature in ServiceNow enables automated detection and mapping of AWS Database Migration Service (DMS) endpoints within your cloud environment. This functionality leverages the Discovery and Service Mapping Patterns application to populate comprehensive DMS endpoint data into both CMDB and non-CMDB tables, facilitating accurate asset management and operational visibility.
Show less
Prerequisites and Setup
- Update Application: Ensure the latest version of the Discovery and Service Mapping Patterns application is installed from the ServiceNow Store to support AWS DMS endpoint discovery.
- AWS Discovery Prerequisites: Follow AWS-specific discovery prerequisites as detailed in the Amazon AWS Cloud components discovery documentation to enable successful pattern operation.
- Resource Inclusion List: Verify and remove any AWS DMS endpoints from the Resource Inclusion List table ([sacloudinventoryresourcewhitelist]) to prevent duplicate discoveries.
- Enable Pattern: The AWS DMS Endpoint discovery pattern is disabled by default. Activate it starting with Visibility Content version 6.28.0. Pattern activation now persists through upgrades and receives ongoing updates.
Data Storage and Tables
The discovery process populates data into two primary areas:
- Non-CMDB Tables: Running the "Amazon AWS - DMS Endpoint - Extended Inventory (LP)" pattern populates detailed endpoint data into non-CMDB AWS-specific tables accessible via All > Configuration > AWS.
- CMDB Tables: The same pattern populates core resource information into the CMDB, specifically the Cloud Resource [cmdbcicmpresource] table, to support configuration management and operational processes.
Key Fields in AWS DMS Endpoint Table [cmdbawsdmsendpoint]
- Name, Object ID (ARN), Username, Database Name, Endpoint Type (source/target), Engine Name
- KMS Key ID for encryption, Server Name/IP, Port, Connection Status, Endpoint Identifier
- Configuration Item reference to the Cloud Resource record
Key Fields in Cloud Resource Table [cmdbcicmpresource]
- Object ID (ARN), Name, Resource Type (fixed as AWS::DMS::Endpoint)
- Operational Status (default: Operational), Install Status (default: Installed)
CI Relationships and Tag Discovery
The discovery pattern establishes important relationships and references to support mapping:
- CI Relationship: The Cloud Resource is mapped as hosted on an AWS Datacenter record.
- CI References: AWS DMS Endpoint records reference their associated Cloud Resource, and Key Value records reference configuration items for tag management.
- AWS Tag Collection: Tags from AWS DMS endpoints are collected and stored in the Key Value [cmdbkeyvalue] table, associating tag keys and values with the Cloud Resource records.
Benefits for ServiceNow Customers
By enabling AWS DMS Endpoints pattern-based discovery, ServiceNow customers gain automated, accurate visibility into their AWS DMS endpoint configurations. This ensures up-to-date CMDB data, supports operational status tracking, and integrates cloud resource tagging for enhanced governance and reporting. The seamless pattern activation and continuous updates simplify maintenance and improve discovery reliability.
Discovery and Service Mapping Patterns finds AWS DMS endpoints on your cloud environment. Discovering some of these resources may require updating to the latest version of the Discovery and Service Mapping Patterns application from the ServiceNow Store.
Pattern-based discovery and mapping requirements
- Verify the AWS discovery prerequisites
- For more information, see the prerequisites section in Amazon AWS Cloud components discovery using patterns.
- Remove resources from the Resource Inclusion List table
- Verify that the relevant resource isn't listed in the Resource Inclusion List [sa_cloud_inventory_resource_whitelist] table to avoid duplicate discovery. For more information on removing resources from the Resource Inclusion List, see Amazon Web Services (AWS) Resource Inventory.
- Enable the relevant pattern
- The pattern for this service is disabled by default. Starting with Visibility Content version 6.28.0, activating or deactivating a pattern won't be considered a customization, and it will continue to receive updates. Patterns that were previously activated or deactivated will reset to the latest predefined version after upgrading while retaining the last active field value. For more information on enabling patterns, see Activate a disabled pattern.
Discovery and Service Mapping Patterns application populates data in both CMDB and non-CMDB tables.
Data stored in non-CMDB tables
Discovery and Service Mapping Patterns application populates data in the non-CMDB table when running the Amazon AWS - DMS Endpoint - Extended Inventory (LP) pattern.
You can review the non-CMDB AWS tables by navigating to . You can also search the navigation filter for the specific pattern name.
| Field | Description |
|---|---|
| Name [name] | Identifier of the DMS endpoint. |
| Object ID [object_id] | Amazon Resource Name (ARN) that uniquely identifies the DMS endpoint. |
| Username [username] | Username used to connect to the endpoint database. |
| Database Name [database_name] | Name of the database at the endpoint. |
| Endpoint Type [endpoint_type] | Type of the endpoint: source or target. |
| Engine Name [engine_name] | Database engine used by the endpoint. |
| Kms Key Id [kms_key_id] | ARN of the Key Management Service (KMS) key used to encrypt the connection parameters. |
| Server Name [server_name] | Name or IP address of the server hosting the endpoint database. |
| Port [port] | Port used to connect to the endpoint database. |
| Status [status] | Connection status of the endpoint. |
| Endpoint Identifier [endpoint_identifier] | Identifier of the DMS endpoint. |
| Configuration Item [configuration_item] | References the Cloud Resource [cmdb_ci_cmp_resource] table. |
Data stored in CMDB tables
Discovery and Service Mapping Patterns application populates data in the CMDB when running the Amazon AWS - DMS Endpoint - Extended Inventory (LP) pattern.
| Field | Description |
|---|---|
| Object ID [object_id] | ARN that uniquely identifies the DMS endpoint. |
| Name [name] | Identifier of the DMS endpoint. |
| Resource type [resource_type] | Type of resource. The value is set to AWS::DMS::Endpoint. |
| Operational status [operational_status] | Operational status of the resource. Default value is Operational. |
| Install Status [install_status] | Install status of the resource. Default value is Installed. |
CI relationships
The Amazon AWS - DMS Endpoint - Extended Inventory (LP) pattern creates the following relationships and references to support AWS DMS endpoint discovery. References link to records in other tables and don't appear in the CI Relationship [cmdb_rel_ci] table.
| CI | Relationship | CI |
|---|---|---|
| Cloud Resource [cmdb_ci_cmp_resource] | Hosted on::Hosts | AWS Datacenter [cmdb_ci_aws_datacenter] |
| CI | Field | Referenced CI |
|---|---|---|
| AWS DMS Endpoint [cmdb_aws_dms_endpoint] | Configuration Item [configuration_item] | Cloud Resource [cmdb_ci_cmp_resource] |
| Key Value [cmdb_key_value] | Configuration item [configuration_item] | Cloud Resource [cmdb_ci_cmp_resource] |
AWS Tag discovery
The Amazon AWS - DMS Endpoint - Extended Inventory (LP) pattern collects tags and populates them in the Key Value [cmdb_key_value] table.
| Field | Description |
|---|---|
| Key [key] | Tag name. |
| Value [value] | Tag value. |
| Configuration item [configuration_item] | References the Cloud Resource [cmdb_ci_cmp_resource] table. |