AWS DMS Endpoints pattern-based discovery
Summarize
Summary of AWS DMS Endpoints pattern-based discovery
The AWS DMS Endpoints pattern-based discovery enables ServiceNow customers to automatically discover AWS Database Migration Service (DMS) endpoints within their cloud environment. This pattern is part of the Discovery and Service Mapping Patterns application and helps populate detailed endpoint data into both CMDB and non-CMDB tables, improving cloud resource tracking and management.
Show less
Key Features
- Pattern Activation: The AWS DMS Endpoint discovery pattern is disabled by default and must be enabled to start discovery. With Visibility Content version 6.28.0 and later, enabling or disabling patterns is no longer treated as a customization, ensuring smooth updates.
- Data Population: The discovery populates AWS DMS endpoint details into two main tables:
- Non-CMDB Table:
cmdbawsdmsendpointstores detailed attributes such as endpoint name, ARN, username, database name, endpoint type, engine name, server details, port, status, and KMS key ID. - CMDB Table:
cmdbcicmpresourcestores general cloud resource information including ARN, name, resource type (set as AWS::DMS::Endpoint), operational status, and install status.
- Non-CMDB Table:
- CI Relationships and References: The pattern creates and maintains relationships such as “Hosted on” links to AWS datacenter CIs and references between the DMS endpoint and cloud resource records to maintain data integrity and context.
- AWS Tag Discovery: Tags associated with DMS endpoints are collected and stored in the
cmdbkeyvaluetable, linked back to the relevant cloud resource CI for enhanced categorization and filtering. - Resource Inclusion List: Customers must ensure that the DMS endpoints are not listed in the Resource Inclusion List table (
sacloudinventoryresourcewhitelist) to avoid duplicate discoveries. - Prerequisites: AWS discovery prerequisites must be met as outlined in the AWS discovery using patterns documentation to ensure successful discovery.
Practical Benefits for ServiceNow Customers
- Automatically discover and maintain accurate, up-to-date records of AWS DMS endpoints in the CMDB and supplementary tables.
- Gain visibility into endpoint configuration details, connection statuses, and encryption keys, which supports security and operational monitoring.
- Leverage established CI relationships to understand the hosting environment and dependencies, aiding impact analysis and incident management.
- Use AWS tagging information for improved asset management, compliance, and reporting within ServiceNow.
- Ensure efficient cloud inventory management by preventing duplicate discoveries through proper Resource Inclusion List management.
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 AWS 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 AWS Resource Inventory discovery with Patterns.
- 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. |