Amazon SQS Queue pattern-based discovery
Summarize
Summary of Amazon SQS Queue pattern-based discovery
The Amazon SQS Queue pattern-based discovery in ServiceNow enables automated detection and mapping of Amazon Simple Queue Service (SQS) queues within your AWS cloud environment. This discovery is part of the Discovery and Service Mapping Patterns application and requires adherence to AWS discovery prerequisites and proper configuration to avoid duplicate records and ensure accurate data collection.
Show less
Key Features
- Pattern Activation: The SQS Queue discovery pattern is disabled by default. From Visibility Content version 6.28.0 onward, activating or deactivating patterns is not considered a customization and will receive updates automatically.
- GovCloud Support: Discovery supports AWS GovCloud (US) accounts, requiring the use of a datacenter URL during AWS service account setup.
- Data Population: The discovery populates data into both CMDB and non-CMDB tables:
- Non-CMDB Table: The
cmdbawssqsqueuetable stores details such as queue name, ARN, URL, FIFO status, maximum message size, and configuration item references. - CMDB Table: The
cmdbcicloudmessagingservicetable stores the SQS queue as a cloud messaging service, including attributes like name, ARN, resource type (AWS::SQS::Queue), installation status, and operational status.
- Non-CMDB Table: The
- CI Relationships and References: The pattern establishes relationships linking SQS queues to AWS datacenters and maintains references between the AWS SQS queue and the cloud messaging service records to support comprehensive service mapping.
- AWS Tag Discovery: Tags associated with SQS queues are collected and stored in the
cmdbkeyvaluetable, linked back to the corresponding cloud messaging service.
Practical Considerations for ServiceNow Customers
- Ensure AWS discovery prerequisites are met before enabling the pattern to avoid discovery failures.
- Remove any SQS queue resources from the Resource Inclusion List to prevent duplicate discovery records.
- Activate the Amazon AWS - SQS Queue - Extended Inventory (LP) pattern to start discovering SQS queues.
- Configure discovery schedules appropriately, especially when working with AWS GovCloud environments.
- Use the populated CMDB and non-CMDB data for accurate service mapping, inventory management, and operational visibility of your AWS SQS queues.
Discovery and Service Mapping Patterns finds Amazon SQS Queues 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.
- Configure the Discovery schedule to support GovCloud
- Discovering AWS GovCloud (US) accounts requires using a datacenter URL when setting up an AWS service account. For more information, see Create AWS service accounts.
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 - SQS Queue - 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 SQS queue. |
| Object ID [object_id] | The Amazon Resource Name (ARN) of the SQS queue. |
| Queue URL [queue_url] | The URL of the SQS queue. |
| FIFO Queue [fifo_queue] | Indicates whether the queue is a First-In-First-Out (FIFO) queue.
|
| Maximum Message Size [maximum_message_size] | The maximum size of a message that can be sent to the queue, in bytes. |
| Configuration Item [configuration_item] | References the Cloud Messaging Service [cmdb_ci_cloud_messaging_service] table. |
Data stored in CMDB tables
Discovery and Service Mapping Patterns application populates data in the CMDB when running the Amazon AWS - SQS Queue - Extended Inventory (LP) pattern.
| Field | Description |
|---|---|
| Name [name] | Name of the SQS queue. |
| Object ID [object_id] | The ARN of the SQS queue. |
| Type [type] | Type of resource. The value is set to AWS::SQS::Queue. |
| 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 - SQS Queue - Extended Inventory (LP) pattern creates the following relationships and references to support Amazon SQS Queue discovery. References link to records in other tables and don't appear in the CI Relationship [cmdb_rel_ci] table.
| CI | Relationship | CI |
|---|---|---|
| Cloud Messaging Service [cmdb_ci_cloud_messaging_service] | Hosted on::Hosts | AWS Datacenter [cmdb_ci_aws_datacenter] |
| CI | Field | Referenced CI |
|---|---|---|
| AWS SQS Queue [cmdb_aws_sqs_queue] | Configuration Item [configuration_item] | Cloud Messaging Service [cmdb_ci_cloud_messaging_service] |
| Key Value [cmdb_key_value] | Configuration item [configuration_item] | Cloud Messaging Service [cmdb_ci_cloud_messaging_service] |
AWS Tag discovery
The Amazon AWS - SQS Queue - 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 Messaging Service [cmdb_ci_cloud_messaging_service] table. |