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 find and inventory AWS Systems Manager Documents within their cloud environment using the Discovery and Service Mapping Patterns application. This process helps populate data in both CMDB and non-CMDB tables, allowing for comprehensive tracking and management of these AWS resources.
Show less
Prerequisites and Setup
- Verify AWS discovery prerequisites as outlined in the Amazon AWS Cloud components discovery using patterns documentation.
- Ensure that the relevant Systems Manager Documents are not listed in the Resource Inclusion List table (
sacloudinventoryresourcewhitelist) to avoid duplicate discovery. - The pattern for AWS Systems Manager Document discovery is disabled by default and must be enabled. Activating or deactivating patterns will not be treated as a customization and patterns will receive updates automatically.
Data Storage and Tables
The discovery application stores AWS Systems Manager Document data in two types of tables:
- Non-CMDB tables: Populated when running the Amazon AWS - Systems Manager Document - Extended Inventory (LP) pattern, accessible under All > Configuration > AWS. Key table:
cmdbawssystemsmanagerdocument. - CMDB tables: The same pattern also populates the CMDB with resource details, primarily in the
cmdbcicmpresourcetable, representing the Systems Manager Documents as configuration items.
Key Fields Captured
- In
cmdbawssystemsmanagerdocument: Includes document name, ARN (object ID), format (JSON, YAML, or TEXT), type (e.g., Command, Automation), version, owner AWS account ID, author, display name, and review status. - In
cmdbcicmpresource: Captures resource name, ARN, resource type (AWS::SystemsManager::Document), install status (default Installed), and operational status (default Operational).
Configuration Item Relationships and References
- The discovery pattern establishes relationships such as Hosted on::Hosts linking Systems Manager Documents to AWS Datacenters (
cmdbciawsdatacenter). - References between Systems Manager Document entries and Cloud Resource records are maintained, supporting traceability without cluttering the CI Relationship table.
AWS Tag Discovery
The pattern captures AWS tags associated with Systems Manager Documents and stores them in the cmdbkeyvalue table, linking tag names and values back to the respective Cloud Resource records.
Benefits for ServiceNow Customers
- Accurately discover and inventory AWS Systems Manager Documents within ServiceNow CMDB and related tables.
- Maintain up-to-date resource information including versions, ownership, and status.
- Leverage established relationships and tags to understand resource context and enhance cloud environment visibility.
- Simplify management and auditing of AWS Systems Manager Documents through integrated ServiceNow patterns that are easy to enable and update.
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 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 - 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. |