Amazon EC2 VPC Endpoint Service pattern-based discovery
Summarize
Summary of Amazon EC2 VPC Endpoint Service pattern-based discovery
This discovery and service mapping pattern enables ServiceNow customers to identify and map Amazon EC2 VPC Endpoint Services within their AWS cloud environment. It is part of the Discovery and Service Mapping Patterns application, which finds AWS services and populates related configuration items (CIs) and metadata into the ServiceNow CMDB and associated tables.
Show less
Key Features
- Pattern Activation: The pattern for Amazon EC2 VPC Endpoint Service discovery is disabled by default. Customers must enable it in the Discovery and Service Mapping Patterns application to start discovering these services. Activation or deactivation no longer counts as customizations and reset to the latest version after upgrades while preserving active status.
- AWS Discovery Prerequisites: Customers must meet AWS discovery prerequisites, including removing any relevant resources from the Resource Inclusion List [sacloudinventoryresourcewhitelist] table to prevent duplicate discovery.
- GovCloud Support: Discovery supports AWS GovCloud (US) accounts by configuring the discovery schedule with the appropriate datacenter URL when setting up AWS service accounts.
- Data Storage: Discovered data is stored in both CMDB and non-CMDB tables:
- Non-CMDB Tables: Populated when running the extended inventory pattern, allowing customers to review AWS-specific inventory data.
- CMDB Tables: Key CIs such as
cmdbawselasticcloudcomputevpcendpointserviceandcmdbcicloudgatewayare populated with detailed information about the VPC Endpoint Service.
- CI Relationships: The pattern establishes relationships between the VPC Endpoint Service CI and AWS Datacenter CIs, as well as references to Cloud Gateway CIs, supporting comprehensive service mapping.
- AWS Tag Discovery: Tags associated with VPC Endpoint Services are collected and stored in the
cmdbkeyvaluetable, enabling better classification and filtering of cloud resources.
Key Configuration Details
- VPC Endpoint Service Attributes: The pattern collects the Amazon Resource Name (ARN), service name, service ID, type (e.g., Interface or Gateway), and customer management status.
- Cloud Gateway CI: Contains ARN, name, install and operational status, and a description identifying it as an AWS Elastic Compute Cloud VPC Endpoint Service.
Practical Benefits for ServiceNow Customers
By enabling this pattern, customers can automatically discover and maintain accurate, up-to-date CMDB entries for Amazon EC2 VPC Endpoint Services. This improves visibility into AWS cloud infrastructure, supports impact analysis, and enhances cloud governance through detailed tagging and relationship mapping. The pattern’s support for GovCloud and management of data in both CMDB and non-CMDB tables ensures comprehensive inventory management across AWS environments.
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. |