---
sourceDocument: Yokohama IT Operations Management
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/yokohama/it-operations-management

 Release :

    - yokohama

ft:locale :

    - en-US

ft:publication_title :

    - Yokohama IT Operations Management

ft:clusterId :

    - itom

bundleId :

    - itom

workflow :

    - Technology


---

# Amazon API Gateway Domain Name

# Amazon API Gateway Domain Name pattern-based discovery {#ariaid-title1}

* Release version: Yokohama
* 
* Updated August 11, 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 Amazon API Gateway Domain Name pattern-based discovery

The Amazon API Gateway Domain Name pattern-based discovery enables ServiceNow customers to identify and map API Gateway domain names within their AWS cloud environments.
Using the Discovery and Service Mapping Patterns application, this process populates relevant data into both CMDB and non-CMDB tables, supporting accurate asset and configuration management of AWS API Gateway domain names.
Show full answer Show less  

## Key Features

* **Pattern Activation:** The discovery pattern for API Gateway Domain Names is disabled by default. Starting with Visibility Content version 6.28.0, enabling or disabling this pattern does not count as customization and will be updated automatically. Patterns reset to the latest predefined version after upgrades while retaining the last active status.
* **AWS Prerequisites:** Customers must verify AWS discovery prerequisites and remove relevant resources from the Resource Inclusion List (\[sacloudinventoryresourcewhitelist\]) to avoid duplicate discovery.
* **GovCloud Support:** Discovery for AWS GovCloud (US) requires configuring the AWS service account with a datacenter URL.
* **Data Population:** The pattern populates data in two areas:
  * **Non-CMDB Tables:** Via the Amazon AWS - API Gateway Domain Name - Extended Inventory (LP) pattern, data such as domain names and certificate details are stored in tables accessible under All \> Configuration \> AWS.
  * **CMDB Tables:** Corresponding configuration items (CIs) are created in the CMDB with attributes like resource type ("AWS::API Gateway::Domain Name"), install status, and operational status.
* **Relationships:** The pattern establishes CI relationships linking the API Gateway Domain Name resource to AWS Datacenter and Cloud Resource CIs, supporting comprehensive dependency mapping.
* **Tag Discovery:** AWS tags are collected and stored in the Key Value \[cmdbkeyvalue\] table, enabling tag-based filtering and management.

## What Customers Can Expect

* Automated discovery and inventory of AWS API Gateway custom domain names, including status, endpoint type, and associated SSL/TLS certificates.
* Accurate representation of API Gateway Domain Names within the ServiceNow CMDB, facilitating enhanced visibility and operational insight.
* Support for AWS GovCloud environments with appropriate service account configurations.
* Consistent updates and maintenance of discovery patterns without losing custom activation states after platform upgrades.
* Comprehensive relationship mapping to AWS datacenters and cloud resources, improving impact analysis and change management.
* Tag collection for refined asset categorization and reporting.  
Discovery and Service Mapping Patterns finds AWS services 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 {#aws-api-gateway-domain-name__selection_ipy_53n_jfc}

Verify the AWS discovery prerequisites
:   For more information, see the prerequisites section in [Amazon AWS Cloud components discovery using patterns](https://servicenow-prod.fluidtopics.net/nnBwzYmMo_kpTZpG3y5~xQ "Discovery and Service Mapping Patterns uses patterns to discover components of the Amazon AWS Cloud deployment during horizontal discovery. Discovering some of these resources may 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 [Amazon Web Services (AWS) Resource Inventory](https://servicenow-prod.fluidtopics.net/U2bwxjeyIbyEXySOOJQkYA "The ServiceNow Discovery and Service Mapping applications can find and map the AWS resources available by AWS Config Service. Discovering some of these resources may 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://servicenow-prod.fluidtopics.net/R5W5GP640V_5uNIhVNRPCw "If you want to use a pattern for discovery that's disabled by default, activate it manually.").{#aws-api-gateway-domain-name__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://servicenow-prod.fluidtopics.net/CvTA68TY3ph_FRR49RbdPg "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-api-gateway-domain-name__section_aq4_qkq_hfc}

Discovery and Service Mapping Patterns application populates data in the non-CMDB table when running the Amazon AWS - API Gateway Domain Name - 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-api-gateway-domain-name__section_aq4_qkq_hfc__entry__2}

| Field | Description |
|-|-|
| Object Id \[object_id\] | The Amazon Resource Name (ARN) uniquely identifying the domain. |
| Name \[name\] | The custom domain name associated with an API Gateway. |
| Certificate Name \[certificate_name\] | The name of the secure sockets layer and transport layer security (SSL/TLS) certificate used for the domain. |
| Configuration Item \[configuration_item\] | References the Cloud Resource \[cmdb_ci_cmp_resource\] table. |
| Domain Name Status \[domain_name_status\] | The status of the custom domain name. |
| Endpoint Type \[endpoint_type\] | The type of API endpoint. For example: EDGE or REGIONAL. |
[Table 1. AWS API Gateway - Domain Name \[cmdb_aws_api_gateway_domain_name\]]

## Data stored in CMDB tables

Discovery and Service Mapping Patterns application populates data in the CMDB when running the Amazon AWS - API Gateway Domain Name - Extended Inventory (LP) pattern.  
{#aws-api-gateway-domain-name__entry__16}

| Field | Description |
|-|-|
| Object ID \[object_id\] | The ARN uniquely identifying the domain. |
| Name \[name\] | The custom domain name associated with an API Gateway. |
| Resource type \[resource_type\] | Type of resource. The value is set to AWS::API Gateway::Domain Name. |
| 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. |
[Table 2. Cloud Resource \[cmdb_ci_cmp_resource\]]

## CI relationships

The Amazon AWS - API Gateway Domain Name - Extended Inventory (LP) pattern creates these relationships to support Amazon API Gateway Domain Name discovery.  
{#aws-api-gateway-domain-name__entry__29}

| CI | Relationship | CI |
|-|-|-|
| Cloud Resource \[cmdb_ci_cmp_resource\] | Hosted on::Hosts | AWS Datacenter \[cmdb_ci_aws_datacenter\] |
| AWS API Gateway - Domain Name \[cmdb_aws_api_gateway_domain_name\] | References | Cloud Resource \[cmdb_ci_cmp_resource\] |
[ ]

## AWS tag discovery {#aws-api-gateway-domain-name__section_ezc_jwt_jfc}

The pattern collects tags and populates them in the Key Value \[cmdb_key_value\] table. {#aws-api-gateway-domain-name__table_axq_spc_y2c__entry__2}

| Field | Description |
|-|-|
| Key \[key\] | Tag name. |
| Value \[value\] | Tag value. |
[Table 3. Key Value \[cmdb_key_value\]]

{#aws-api-gateway-domain-name__table_axq_spc_y2c}

*[\>]: and then


