AWS AppSync API pattern-based discovery

  • Release version: Australia
  • Updated May 6, 2026
  • 2 minutes to read
    • Summarize
    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 using Discovery and Service Mapping Patterns. This functionality integrates discovered data into both CMDB and non-CMDB tables, providing a comprehensive view of AWS AppSync API resources and their relationships.

    Show full answer Show less

    Key Features

    • Pattern Activation: The AppSync API discovery pattern is disabled by default and must be enabled. From Visibility Content version 6.28.0 onward, enabling or disabling patterns does not count as customization and patterns reset to the latest version after upgrades while preserving the last active state.
    • Prerequisites and Configuration: Customers must meet AWS discovery prerequisites, remove relevant resources from the Resource Inclusion List to avoid duplicate discovery, and configure discovery schedules appropriately—especially for AWS GovCloud accounts using datacenter URLs.
    • Data Storage: Discovered AWS AppSync API data is populated in both non-CMDB and CMDB tables. Non-CMDB tables can be reviewed under All > Configuration > AWS, while CMDB tables include detailed records of cloud messaging services representing the AppSync APIs.
    • Key Tables and Fields:
      • cmdbawsappsyncapi: Stores unique identifiers (ARN, API ID), names, owner contact, DNS endpoints for real-time subscriptions and GraphQL queries, and references to the cloud messaging service CI.
      • cmdbcicloudmessagingservice: Represents the AppSync API as a cloud messaging service CI, including operational and install status fields.
      • cmdbkeyvalue: Stores AWS tags associated with the AppSync APIs, linked back to the cloud messaging service CI.
    • CI Relationships and References: The pattern creates relationships such as "Hosted on::Hosts" linking cloud messaging services to AWS datacenters, and maintains references between AppSync API records and cloud messaging service configuration items.

    Practical Benefits

    • Enables detailed discovery and mapping of AWS AppSync APIs, improving visibility into cloud messaging services in the CMDB.
    • Supports automated tagging and relationship management, facilitating governance and operational insights.
    • Ensures accurate and up-to-date discovery through pattern versioning and compatibility with AWS GovCloud environments.

    Discovery and Service Mapping Patterns finds AWS AppSync APIs 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 - AppSync API - Extended Inventory (LP) pattern.

    You can review the non-CMDB AWS tables by navigating to All > Configuration > AWS. You can also search the navigation filter for the specific pattern name.

    Table 1. AWS AppSync API [cmdb_aws_appsync_api]
    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.

    Data stored in CMDB tables

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

    Table 2. Cloud Messaging Service [cmdb_ci_cloud_messaging_service]
    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.

    CI relationships

    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.

    Table 3. CI relationships
    CI Relationship CI
    Cloud Messaging Service [cmdb_ci_cloud_messaging_service] Hosted on::Hosts AWS Datacenter [cmdb_ci_aws_datacenter]
    Table 4. CI references
    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]

    AWS Tag discovery

    The Amazon AWS - AppSync API - Extended Inventory (LP) pattern collects tags and populates them in the Key Value [cmdb_key_value] table.

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