Amazon API Gateway discovery with Patterns
The ServiceNow Discovery and Service Mapping applications use the Amazon AWS API Gateway pattern to find Amazon API Gateways and connections to other entities. Discovering some of these resources may require updating to the latest version of the Discovery and Service Mapping Patterns application from the ServiceNow Store.
Starting with Discovery and Service Mapping Patterns version 1.29.0, the Amazon AWS API Gateway pattern data model has changed.
Amazon AWS API Gateway pattern new data model relationships
Request apps on the Store
Visit the ServiceNow Store to view all the available apps, and for information about submitting requests to the store. For cumulative release notes information for all released apps, see the ServiceNow Store version history release notes.
Prerequisites
Verify the AWS prerequisites
For more information, see the prerequisite section in AWS discovery using patterns.
Retire legacy data model CIs to avoid duplicates
To avoid duplicate CIs, activate a schedule job to mark legacy data model CIs as retired. For more information, see Retire legacy AWS API Gateway data model CIs.
Data collected by Discovery during horizontal discovery
Discovery populates the data in the CMDB when running the Amazon AWS API Gateway pattern.
| Field | Description |
|---|---|
| Name \[name\] | Concatenate of "aws-gateway-" + account ID + region.For example: aws-gateway-000000000000-us-east-1. |
| ID \[id\] | Concatenate of "aws-gateway-" + account ID + region.For example: aws-gateway-000000000000-us-east-1. |
| Install Status \[install\_status\] | Install status of the AWS gateway. Default value is Installed. |
| Operational status \[operational\_status\] | Operational status of the AWS gateway. Default value is Operational. |
| Field | Description |
|---|---|
| ID \[id\] | Concatenate of "https://" + API ID + ".execute-api." + region + ".amazonaws.com". For example: https://a1b2c3d4e5.execute-api.us-east-1.amazonaws.com. |
| Name \[name\] | Name of the API. |
| Description \[short\_description\] | Description of API. |
| Install Status \[install\_status\] | Install status of the API. Default value is Installed. |
| Operational status \[operational\_status\] | Operational status of the API. Default value is Operational. |
| Type \[type\] | Type of API: REST. |
| Version \[version\] | Version of API. |
| Fully qualified domain name \[fqdn\] | Concatenate of API ID + ".execute-api." + region + ".amazonaws.com".For example: a1b2c3d4e5.execute-api.us-east-1.amazonaws.com. |
| Field | Description |
|---|---|
| Name [name] | Unique name or IP address of the DNS host. |
| IP Address [ip_address] | IP address of the DNS host. |
aWS API gateway CIs and connections on a Dependency Views map
Relationships
Discovery creates these relationships to support Amazon API Gateway discovery.
| CI | Relationship | CI |
|---|---|---|
| AWS API Gateway [cmdb_ci_aws_api_gateway] | Provides::Provided by | Managed API [cmdb_ci_managed_api] |
| Managed API [cmdb_ci_managed_api] | Hosted on::Hosts | AWS Datacenter [cmdb_ci_aws_datacenter] |
| Managed API [cmdb_ci_managed_api] | Uses::Used by | DNS Name [cmdb_ci_dns_name] |
| DNS Name [cmdb_ci_dns_name] | Hosted on::Hosts | AWS Datacenter [cmdb_ci_aws_datacenter] |
| Key Value [cmdb_key_value] | References | Managed API [cmdb_ci_managed_api] |
Tag discovery
The Amazon AWS API Gateway pattern collects tags and populates them in the Key Value [cmdb_key_value] table.
| Field | Description |
|---|---|
| Key [key] | Tag name. |
| Value [value] | Tag value. |
| Configuration item [configuration_item] | References the Managed API [cmdb_ci_managed_api] table. |
Connections discovered by Service Mapping during the top-down discovery
Service Mapping performs the top-down discovery of the AWS API Gateways in the context of application services. It discovers outgoing connections of the AWS API Gateways:
- AWS Lambda
- VPC Link for Virtual Private Cloud
HTTP endpoint defined as the configured URL on the API Gateway
Test patterns for discovering AWS API Gateway and AWS Lambda
Run the horizontal and top-down discovery using Amazon AWS API Gateway [cmdb_ci_cloud_gateway] and Amazon AWS Lambda [cmdb_ci_cloud_function] patterns. Verify that the result is as expected.- Retire legacy AWS API Gateway data model CIs
Avoid duplicate AWS API Gateway configuration items (CIs) by retiring legacy data model CIs through a scheduled job.
Parent Topic:AWS discovery using patterns