Amazon VPC Flow Log pattern-based discovery
Summarize
Summary of Amazon VPC Flow Log pattern-based discovery
The Amazon VPC Flow Log pattern-based discovery in ServiceNow identifies Amazon Virtual Private Cloud (Amazon VPC) Flow Logs within your cloud environment. It is part of the Discovery and Service Mapping Patterns application and requires updating to the latest version for optimal functionality.
Show less
Prerequisites and Setup
- AWS Discovery Prerequisites: Ensure all AWS discovery requirements are met as outlined in the Amazon AWS Cloud components discovery documentation.
- Resource Inclusion List: Verify that VPC Flow Log resources are not present in the Resource Inclusion List table ([sacloudinventoryresourcewhitelist]) to prevent duplicate discovery.
- Enable Pattern: The VPC Flow Log discovery pattern is disabled by default and must be activated. Starting with Visibility Content version 6.28.0, enabling or disabling patterns no longer counts as customization and patterns reset to the latest version after upgrades while preserving activation status.
Data Storage and Tables
The discovery process populates data into both CMDB and non-CMDB tables, depending on the pattern run:
- Non-CMDB tables: When executing the Amazon AWS - VPC Flow Log - Extended Inventory (LP) pattern, data is stored in non-CMDB AWS tables, accessible via the ServiceNow navigation under All > Configuration > AWS.
- CMDB tables: The same pattern also populates key VPC Flow Log data in the CMDB, specifically in the Cloud Resource [cmdbcicmpresource] table.
Key Fields Captured
- In AWS VPC Flow Log [cmdbawsvpcflowlog]: flow log ID (name), unique object ID, associated resource ID (e.g., VPC, subnet), log delivery status (SUCCESS or FAILED), flow log status (ACTIVE when running), and a reference to the configuration item.
- In Cloud Resource [cmdbcicmpresource]: flow log ID (name), unique object ID, resource type (AWS::VPC::FlowLog), install status (default Installed), and operational status (default Operational).
Relationships and Tags
The discovery pattern establishes:
- CI Relationships: Links the Cloud Resource to its hosting AWS Datacenter via “Hosted on::Hosts” relationship.
- CI References: The AWS VPC Flow Log references the Cloud Resource configuration item and key-value pairs.
- AWS Tag Collection: Tags associated with VPC Flow Logs are collected and stored as key-value pairs in the Key Value [cmdbkeyvalue] table, linked to the Cloud Resource configuration item.
Practical Benefits for ServiceNow Customers
This pattern-based discovery enables you to automatically detect and maintain accurate records of your Amazon VPC Flow Logs in ServiceNow, enhancing your CMDB with detailed flow log information, status, and tags. It improves visibility into your cloud network traffic logs, supports better resource management, and integrates flow log data within your overall cloud asset inventory and service mapping.
Discovery and Service Mapping Patterns finds Amazon Virtual Private Cloud (Amazon VPC) Flow Logs 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 Amazon AWS Cloud components 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 Amazon Web Services (AWS) Resource Inventory.
- 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.
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 - VPC Flow Log - 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 |
|---|---|
| Name [name] | The flow log ID, used as the display name. |
| Object ID [object_id] | The unique identifier of the flow log. |
| Resource ID [resource_id] | The ID of the resource associated with the flow log, such as a VPC, subnet, or network interface. |
| Deliver Logs Status [deliver_logs_status] | The status of the log delivery. The value is SUCCESS or FAILED. |
| Flow Log Status [flow_log_status] | The status of the flow log. The value is ACTIVE when the flow log is running. |
| Configuration Item [configuration_item] | References the Cloud Resource [cmdb_ci_cmp_resource] table. |
Data stored in CMDB tables
Discovery and Service Mapping Patterns application populates data in the CMDB when running the Amazon AWS - VPC Flow Log - Extended Inventory (LP) pattern.
| Field | Description |
|---|---|
| Name [name] | The flow log ID, used as the display name. |
| Object ID [object_id] | The unique identifier of the flow log. |
| Resource type [resource_type] | Type of resource. The value is set to AWS::VPC::FlowLog. |
| 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 - VPC Flow Log - Extended Inventory (LP) pattern creates the following relationships and references to support Amazon VPC Flow Log discovery. References link to records in other tables and don't appear in the CI Relationship [cmdb_rel_ci] table.
| CI | Relationship | CI |
|---|---|---|
| Cloud Resource [cmdb_ci_cmp_resource] | Hosted on::Hosts | AWS Datacenter [cmdb_ci_aws_datacenter] |
| CI | Field | Referenced CI |
|---|---|---|
| AWS VPC Flow Log [cmdb_aws_vpc_flow_log] | Configuration Item [configuration_item] | Cloud Resource [cmdb_ci_cmp_resource] |
| Key Value [cmdb_key_value] | Configuration item [configuration_item] | Cloud Resource [cmdb_ci_cmp_resource] |
AWS Tag discovery
The Amazon AWS - VPC Flow Log - Extended Inventory (LP) 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 Cloud Resource [cmdb_ci_cmp_resource] table. |