AWS Systems Manager Document pattern-based discovery
Summarize
Summary of AWS Systems Manager Document pattern-based discovery
The AWS Systems Manager Document pattern-based discovery enables ServiceNow customers to discover and map AWS Systems Manager Documents within their cloud environment. This capability is part of the Discovery and Service Mapping Patterns application and helps populate data into the ServiceNow CMDB and associated non-CMDB tables, enhancing visibility and management of AWS Systems Manager resources.
Show less
Key Features
- Pattern Activation: The pattern for discovering Systems Manager Documents is disabled by default and must be enabled. Activation or deactivation of the pattern no longer counts as a customization, ensuring it will receive updates and reset to the latest version after upgrades while retaining activation status.
- Prerequisites: Customers must verify AWS discovery prerequisites and ensure relevant resources are not present in the Resource Inclusion List to avoid duplicate discovery.
- Data Population: Discovery populates detailed information in two areas:
- Non-CMDB tables: Using the Amazon AWS - Systems Manager Document - Extended Inventory (LP) pattern, data is stored in specialized AWS non-CMDB tables accessible under All > Configuration > AWS.
- CMDB tables: The same pattern populates data into the CMDB’s Cloud Resource table, representing Systems Manager Documents as Configuration Items (CIs) with attributes such as name, ARN, resource type, install status, and operational status.
- CI Relationships and References: The discovery pattern creates relationships linking Systems Manager Documents to AWS Datacenters, and references between the AWS Systems Manager Document table and Cloud Resource CIs to maintain data integrity and context.
- AWS Tag Collection: Tags associated with Systems Manager Documents are collected and stored in the Key Value table, linked back to the Cloud Resource CI for enhanced filtering and reporting.
Key Outcomes
- Improved visibility and management of AWS Systems Manager Documents within ServiceNow CMDB and related tables.
- Accurate and up-to-date data reflecting document metadata, ownership, versions, formats, and statuses.
- Automatic maintenance of relationships and references ensuring comprehensive resource mapping.
- Tag data availability for governance, compliance, and operational insights.
Discovery and Service Mapping Patterns finds AWS Systems Manager Documents 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 - Systems Manager Document - 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] | Name of the Systems Manager document. |
| Object ID [object_id] | The Amazon Resource Name (ARN) of the document, in the following format: arn:aws:ssm:{region}:{account-id}:document/{document-name}. |
| Document Format [document_format] | The format of the document. The value is JSON, YAML, or TEXT. |
| Document Type [document_type] | The type of the document. For example: Command, Automation, Session, Policy, or Package. |
| Document Version [document_version] | The document version. |
| Owner [owner] | The AWS account ID that owns the document. |
| Author [author] | The author of the document. |
| Display Name [display_name] | The display name of the document. |
| Review Status [review_status] | The review status of the document. The value is APPROVED, PENDING, REJECTED, or NOT_REVIEWED. |
| 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 - Systems Manager Document - Extended Inventory (LP) pattern.
| Field | Description |
|---|---|
| Name [name] | Name of the Systems Manager document. |
| Object ID [object_id] | The ARN of the document, in the following format: arn:aws:ssm:{region}:{account-id}:document/{document-name}. |
| Resource type [resource_type] | Type of resource. The value is set to AWS::SystemsManager::Document. |
| Install Status [install_status] | Install status of the resource. Default value is Installed. |
| Operational status [operational_status] | Operational status of the resource. Default value is Operational. |
CI relationships
The Amazon AWS - Systems Manager Document - Extended Inventory (LP) pattern creates the following relationships and references to support AWS Systems Manager Document 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 Systems Manager Document [cmdb_aws_systems_manager_document] | 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 - Systems Manager Document - 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. |