---
sourceDocument: Australia IT Operations Management
sourceDocumentLink: https://www.servicenow.com/docs/r/australia/it-operations-management

 Release :

    - australia

ft:locale :

    - en-US

ft:publication_title :

    - Australia IT Operations Management

ft:clusterId :

    - itom

bundleId :

    - itom

workflow :

    - Technology


---

# AWS AppSync API

# AWS AppSync API pattern-based discovery {#ariaid-title1}

Release version: Australia  
Updated May 6, 2026  
![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 minutes to read
Summarize  
![AI sparkle icon](https://servicenow.com/docs/portal-asset/ai-sparkle-icon) Summarized using AI  
This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.  

## Summary of AWS AppSync API pattern-based discovery

The AWS AppSync API pattern-based discovery enables ServiceNow customers to automatically identify and map AWS AppSync APIs within their cloud environments.
This discovery is part of the Discovery and Service Mapping Patterns application and requires updating to the latest version from the ServiceNow Store for optimal results.
Show full answer Show less  

## Prerequisites and Setup

* **AWS discovery prerequisites:** Ensure all AWS discovery prerequisites are met as outlined in the AWS discovery using patterns documentation.
* **Resource Inclusion List:** Verify that AWS AppSync API resources are not listed in the Resource Inclusion List table `sacloudinventoryresourcewhitelist` to prevent duplicate discoveries.
* **Enablement of pattern:** The AWS AppSync API discovery pattern is disabled by default. Starting with Visibility Content 6.28.0, pattern activation or deactivation is no longer considered customization and will persist through updates. Patterns reset to the latest version after upgrades but retain the last active state.
* **Discovery schedule configuration:** For AWS GovCloud (US) accounts, use an appropriate datacenter URL when setting up AWS service accounts to ensure discovery functions correctly.

## Data Storage and Tables

The discovery process populates data into both CMDB and non-CMDB tables, providing comprehensive information about AWS AppSync APIs.

### Non-CMDB Data

* Populated when running the **Amazon AWS - AppSync API - Extended Inventory (LP)** pattern.
* Includes the `cmdbawsappsyncapi` table with fields such as Object ID (ARN), API name, API ID, owner contact, DNS endpoints for real-time subscriptions and GraphQL queries, and a reference to the Cloud Messaging Service CI.

### CMDB Data

* Also populated by the same pattern.
* Key table: `cmdbcicloudmessagingservice`, which stores unique ARN, API name, resource type (set to AWS::AppSync::API), operational status (default Operational), and install status (default Installed).

## CI Relationships and References

* **CI relationships:** The Cloud Messaging Service CI is related to the AWS Datacenter CI through a "Hosted on::Hosts" relationship stored in the `cmdbrelci` table.
* **CI references:** The AWS AppSync API CI references the Cloud Messaging Service CI, and the Key Value table references the Cloud Messaging Service CI for tag storage.

## AWS Tag Discovery

The discovery pattern collects AWS tags associated with AppSync APIs and stores them in the `cmdbkeyvalue` table, linking each tag's key and value to the corresponding Cloud Messaging Service configuration item.

## Benefits for ServiceNow Customers

* Automated and up-to-date discovery of AWS AppSync APIs within your cloud environment.
* Seamless integration of AppSync API data into your CMDB and related non-CMDB tables for enhanced visibility.
* Proper configuration and activation of discovery patterns ensure accurate mapping and prevent duplicate data.
* Supports AWS GovCloud discovery with appropriate scheduling and account setup.
* Tag collection enables enriched metadata management for AppSync APIs, aiding governance and operational insights.  
Discovery and Service Mapping Patterns finds AWS AppSync APIs on your cloud environment. Discovering some of these resources might require updating to the latest version of the Discovery and Service Mapping Patterns application from the ServiceNow Store.

## Pattern-based discovery and mapping requirements {#aws-appsync-api__section_rpj_fj2_bgc}

Verify the AWS discovery prerequisites
:   For more information, see the prerequisites section in [AWS discovery using patterns](https://www.servicenow.com/docs/NFaTlkGaSxMWb2bQPsCnCA "Discovery and Service Mapping Patterns uses patterns to discover components of the Amazon AWS Cloud deployment during horizontal discovery. Discovering some of these resources might require updating to the latest version of the Discovery and Service Mapping Patterns application from the ServiceNow Store.").

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](https://www.servicenow.com/docs/0pDNq0441mpy~sExfQvvqA "The ServiceNow Discovery and Service Mapping applications can find and map the AWS resources available by AWS Config Service. Discovering some of these resources might require updating to the latest version of the Discovery and Service Mapping Patterns application from the ServiceNow Store.").

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](https://www.servicenow.com/docs/aypCYVQdO8oFebLMLEI89g "If you want to use a pattern for discovery that's disabled by default, activate it manually.").{#aws-appsync-api__activating-disabled-pattern-not-customization}

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](https://www.servicenow.com/docs/vpueuFRHMWLNi6dzsJv94A "Create AWS service accounts on the ServiceNow AI Platform to access your AWS account during AWS discovery.").
Discovery and Service Mapping Patterns application populates data in both CMDB and non-CMDB tables.

## Data stored in non-CMDB tables {#aws-appsync-api__section_aq4_qkq_hfc}

Discovery and Service Mapping Patterns application populates data in the non-CMDB table when running the Amazon AWS - AppSync API - Extended Inventory (LP) pattern.

You can review the non-CMDB
AWS tables by navigating to AllConfigurationAWS. You can also search the navigation filter for the specific pattern name.  
{#aws-appsync-api__table_non_cmdb__entry__2}

| Field | Description |
|-|-|
| Object ID \[object_id\] | Amazon Resource Name (ARN) that uniquely identifies the AppSync API. |
| Name \[name\] | Name of the AWS AppSync API. |
| API ID \[api_id\] | Unique identifier of the AppSync API. |
| Owner Contact \[owner_contact\] | Contact information for the owner of the AppSync API. |
| DNS Realtime \[dns_realtime\] | Domain Name System (DNS) endpoint for real-time subscriptions. |
| DNS GraphQL \[dns_graphql\] | DNS endpoint for GraphQL queries and mutations. |
| Configuration Item \[configuration_item\] | References the Cloud Messaging Service \[cmdb_ci_cloud_messaging_service\] table. |
[Table 1. AWS AppSync API \[cmdb_aws_appsync_api\]]

{#aws-appsync-api__table_non_cmdb}

## Data stored in CMDB tables {#aws-appsync-api__section_ggp_ql2_bgc}

Discovery and Service Mapping Patterns application populates data in the CMDB when running the Amazon AWS - AppSync API - Extended Inventory (LP) pattern.  
{#aws-appsync-api__table_cmdb__entry__2}

| Field | Description |
|-|-|
| Object ID \[object_id\] | ARN that uniquely identifies the AppSync API. |
| Name \[name\] | Name of the AWS AppSync API, which is the GraphQL interface. |
| Type \[type\] | Type of resource. The value is set to AWS::AppSync::API. |
| 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. |
[Table 2. Cloud Messaging Service \[cmdb_ci_cloud_messaging_service\]]

{#aws-appsync-api__table_cmdb}

## CI relationships and references {#aws-appsync-api__section_dc4_ghc_dgc}

The Amazon AWS - AppSync API - Extended Inventory (LP) pattern creates the following relationships and references to support AWS AppSync API discovery. References link to records in other tables and don't appear in the CI Relationship \[cmdb_rel_ci\] table.  
{#aws-appsync-api__table_relationships__entry__3}

| CI | Relationship | CI |
|-|-|-|
| Cloud Messaging Service \[cmdb_ci_cloud_messaging_service\] | Hosted on::Hosts | AWS Datacenter \[cmdb_ci_aws_datacenter\] |
[Table 3. CI relationships]

{#aws-appsync-api__table_relationships}  
{#aws-appsync-api__table_ci_references__entry__3}

| CI | Field | Referenced CI |
|-|-|-|
| AWS AppSync API \[cmdb_aws_appsync_api\] | 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\] |
[Table 4. CI references]

{#aws-appsync-api__table_ci_references}

## AWS Tag discovery {#aws-appsync-api__section_lyw_zhc_dgc}

The Amazon AWS - AppSync API - Extended Inventory (LP) pattern collects tags and populates them in the Key Value \[cmdb_key_value\] table.  
{#aws-appsync-api__table_ojy_vss_5hc__entry__2}

| 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. |
[Table 5. Key Value \[cmdb_key_value\]]

{#aws-appsync-api__table_ojy_vss_5hc}

*[\>]: and then