Amazon EC2 VPC Endpoint Service pattern-based discovery
Summarize
Summary of Amazon EC2 VPC Endpoint Service pattern-based discovery
The Amazon EC2 VPC Endpoint Service pattern-based discovery enables ServiceNow customers to automatically discover and map AWS VPC Endpoint Services within their cloud environment. This capability is part of the Discovery and Service Mapping Patterns application, which identifies AWS resources and populates detailed information into both CMDB and non-CMDB tables.
Show less
Key Features
- Pattern Activation: The VPC Endpoint Service discovery pattern is disabled by default but can be enabled without affecting future updates starting from Visibility Content version 6.28.0.
- AWS Discovery Prerequisites: Customers must meet AWS discovery prerequisites and ensure that resources are not duplicated by removing them from the Resource Inclusion List table.
- GovCloud Support: Discovery supports AWS GovCloud (US) accounts by requiring configuration of service accounts with datacenter URLs.
- Data Storage: Discovered data is stored in both CMDB and non-CMDB tables, specifically the
cmdbawselasticcloudcomputevpcendpointservice(non-CMDB) andcmdbcicloudgateway(CMDB) tables. - Detailed Resource Attributes: Key fields captured include the ARN (Amazon Resource Name), service name, service ID, service type (Interface or Gateway), customer management status, install and operational status, and descriptive resource type.
- CI Relationships: The pattern establishes relationships linking VPC Endpoint Services to Cloud Gateways and AWS Datacenters, supporting comprehensive service mapping.
- Tag Collection: AWS tags associated with the discovered services are collected and stored in the
cmdbkeyvaluetable with their key-value pairs for enhanced resource categorization and filtering.
Practical Benefits for ServiceNow Customers
- Enables automated and accurate discovery of AWS VPC Endpoint Services, improving visibility into your cloud infrastructure.
- Supports efficient CMDB population with relevant and structured data for configuration management and operational awareness.
- Helps avoid duplicate resource discovery by managing inclusion lists.
- Facilitates tracking of service ownership and operational status to assist in cloud resource governance.
- Provides integration with AWS tagging to enhance reporting, filtering, and governance within ServiceNow.
- Supports discovery in specialized AWS regions like GovCloud, ensuring compliance and coverage across 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. |