Amazon EC2 VPC Endpoint Service pattern-based discovery
Summarize
Summary of Amazon EC2 VPC Endpoint Service pattern-based discovery
This guide explains how ServiceNow's Discovery and Service Mapping Patterns application enables discovery and mapping of Amazon EC2 VPC Endpoint Services within your AWS cloud environment. It focuses on pattern-based discovery that identifies and populates data related to VPC Endpoint Services into ServiceNow's CMDB and associated non-CMDB tables.
Show less
Key Features
- Pattern Activation: The VPC Endpoint Service discovery pattern is disabled by default. Starting with Visibility Content version 6.28.0, enabling or disabling patterns will not be considered a customization and patterns will continue to receive updates and reset to the latest predefined versions after upgrades.
- AWS Discovery Prerequisites: Ensure all AWS discovery prerequisites are met, including removing relevant resources from the Resource Inclusion List table to avoid duplicate discovery.
- GovCloud Support: Discovery supports AWS GovCloud (US) accounts by requiring a specific datacenter URL configuration when setting up the AWS service account.
- Data Population: The discovery pattern populates detailed data in both CMDB and non-CMDB tables:
- Non-CMDB Table: cmdbawselasticcloudcomputevpcendpointservice stores key VPC Endpoint Service attributes such as ARN, name, customer management status, service ID, and service type.
- CMDB Table: cmdbcicloudgateway records the resource with fields including ARN, name, install and operational status, and description indicating the AWS resource type.
- Tag Collection: AWS tags are discovered and stored in the cmdbkeyvalue table with their key and value pairs.
- CI Relationships: The pattern automatically creates relationships linking the VPC Endpoint Service CI to the Cloud Gateway CI and the AWS Datacenter CI to maintain accurate service dependency mappings.
Practical Impact for ServiceNow Customers
By enabling and configuring this pattern-based discovery, customers can achieve accurate visibility into their AWS VPC Endpoint Services within ServiceNow. This supports enhanced cloud asset management, dependency mapping, and operational status tracking in the CMDB. It also facilitates governance for AWS GovCloud environments and ensures consistent updates of discovery patterns without customization conflicts. The detailed attribute capture and tag discovery help improve reporting, automation, and compliance efforts related to AWS resources.
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 - Elastic Compute Cloud VPC Endpoint Service - Extended Inventory (LP) pattern.
You can review the non-CMDB AWS tables by navigating to . You can also search the navigation filter for the specific pattern name.
| Field | Description |
|---|---|
| Object Id [object_id] | The Amazon Resource Name (ARN) uniquely identifying the VPC Endpoint Service. The ARN consists of the AWS region, account ID, and service ID in the following format: arn:aws:ec2:<region>:<accountId>:vpc-endpoint-service/<service_id>. |
| Name [name] | The name assigned to the VPC endpoint service. |
| Configuration Item [configuration_item] | References the Cloud Gateway [cmdb_ci_cloud_gateway] table. |
| Is Customer Managed [is_customer_managed] | Indicates whether the VPC Endpoint Service is managed by a customer or AWS. |
| Service ID [service_id] | The unique identifier for the VPC endpoint service. |
| Service Type [service_type] | The type of the VPC endpoint service. For example: Interface or Gateway. |
Data stored in CMDB tables
Discovery and Service Mapping Patterns application populates data in the CMDB when running the Amazon AWS - Elastic Compute Cloud VPC Endpoint Service - Extended Inventory (LP) pattern.
| Field | Description |
|---|---|
| Object ID [object_id] | The ARN uniquely identifying the VPC Endpoint Service. The ARN consists of the AWS region, account ID, and service ID in the following format: arn:aws:ec2:<region>:<accountId>:vpc-endpoint-service/<service_id>. |
| Name [name] | The name assigned to the VPC endpoint service. |
| 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. |
| Description [short_description] | Type of resource. The value is set to AWS::Elastic Compute Cloud::VPC Endpoint Service. |
CI relationships
The Amazon AWS - Elastic Compute Cloud VPC Endpoint Service - Extended Inventory (LP) pattern creates these relationships to support Amazon EC2 VPC Endpoint Service discovery.
| CI | Relationship | CI |
|---|---|---|
| Cloud Gateway [cmdb_ci_cloud_gateway] | Hosted on::Hosts | AWS Datacenter [cmdb_ci_aws_datacenter] |
| AWS Elastic Compute Cloud - VPC Endpoint Service [cmdb_aws_elastic_cloud_compute_vpc_endpoint_service] | References | Cloud Gateway [cmdb_ci_cloud_gateway] |
AWS tag discovery
| Field | Description |
|---|---|
| Key [key] | Tag name. |
| Value [value] | Tag value. |