Amazon API Gateway Domain Name pattern-based discovery

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

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 - API Gateway Domain Name - 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 API Gateway - Domain Name [cmdb_aws_api_gateway_domain_name]

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.

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.

Table 2. Cloud Resource [cmdb_ci_cmp_resource]

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.

CI relationships

The Amazon AWS - API Gateway Domain Name - Extended Inventory (LP) pattern creates these relationships to support Amazon API Gateway Domain Name discovery.

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

The pattern collects tags and populates them in the Key Value [cmdb_key_value] table.

Table 3. Key Value [cmdb_key_value]

Field	Description
Key [key]	Tag name.
Value [value]	Tag value.