--- 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 --- # Amazon API Gateway Domain Name # Amazon API Gateway Domain Name pattern-based discovery {#ariaid-title1} Release version: Australia Updated March 12, 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 Amazon API Gateway Domain Name pattern-based discovery enables ServiceNow customers to automatically detect and map Amazon API Gateway custom domain names within their AWS cloud environments. This functionality is part of the Discovery and Service Mapping Patterns application, which identifies AWS services and populates relevant configuration management database (CMDB) and non-CMDB tables with detailed resource data. Show full answer Show less ## Key Features * **Pattern Activation:** The pattern for discovering API Gateway Domain Names is disabled by default and must be enabled. From Visibility Content version 6.28.0 onward, activating or deactivating patterns will retain updates and reset to the latest version after upgrades. * **Prerequisites:** Ensure AWS discovery prerequisites are met and relevant resources are not listed in the Resource Inclusion List table to avoid duplicate discovery. * **GovCloud Support:** When discovering AWS GovCloud (US) accounts, configure the discovery schedule with datacenter URLs tailored for GovCloud environments. * **Data Population:** The discovery pattern populates data in both CMDB and non-CMDB tables, providing comprehensive visibility into AWS API Gateway Domain Names and their associated attributes. * **Tag Collection:** AWS tags associated with API Gateway Domain Names are collected and stored in the Key Value table for enhanced categorization and filtering. ## Data and Relationships The discovery populates key fields in two main tables: * **AWS API Gateway - Domain Name \[cmdbawsapigatewaydomainname\]:** Includes unique Amazon Resource Name (ARN), custom domain name, SSL/TLS certificate name, domain name status, and endpoint type (e.g., EDGE or REGIONAL). * **Cloud Resource \[cmdbcicmpresource\]:** Stores resource metadata such as ARN, name, resource type (set to AWS::API Gateway::Domain Name), install status, and operational status. Relationships are created between the discovered domain name resources and AWS Datacenters, supporting accurate mapping without appearing in the standard CI Relationship table. References link domain name records to their corresponding cloud resources. ## Practical Benefits for ServiceNow Customers * Automates discovery and inventory of Amazon API Gateway custom domain names, reducing manual effort. * Ensures accurate representation of AWS API Gateway Domain Names in the CMDB, facilitating better service mapping and impact analysis. * Supports tag-based categorization, aiding in governance and resource management. * Enables discovery in specialized environments such as AWS GovCloud with appropriate configuration. * Maintains up-to-date patterns with simplified activation and upgrade processes. Discovery and Service Mapping Patterns finds AWS services 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-api-gateway-domain-name__selection_ipy_53n_jfc} 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-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://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-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 and references The Amazon AWS - API Gateway Domain Name - Extended Inventory (LP) pattern creates these relationships and references to support Amazon API Gateway Domain Name discovery. References link to records in other tables and don't appear in the CI Relationship \[cmdb_rel_ci\] table. {#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\] | [Table 3. CI relationships] {#aws-api-gateway-domain-name__table_h24_ypb_hkc__entry__3} | CI | Field | Referenced CI | |-|-|-| | AWS API Gateway - Domain Name \[cmdb_aws_api_gateway_domain_name\] | Configuration Item \[configuration_item\] | Cloud Resource \[cmdb_ci_cmp_resource\] | [Table 4. CI references] {#aws-api-gateway-domain-name__table_h24_ypb_hkc} ## 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 5. Key Value \[cmdb_key_value\]] {#aws-api-gateway-domain-name__table_axq_spc_y2c} *[\>]: and then