AWS KMS Key pattern-based discovery
Summarize
Summary of AWS KMS Key pattern-based discovery
The AWS KMS Key pattern-based discovery enables ServiceNow customers to automatically discover AWS KMS Keys within their cloud environments using Discovery and Service Mapping Patterns. This capability helps maintain accurate and up-to-date configuration data by populating information about AWS KMS Keys in both CMDB and non-CMDB tables.
Show less
Key Features
- Prerequisites and Setup: Customers must meet AWS discovery prerequisites and ensure relevant resources are not listed in the Resource Inclusion List table to avoid duplicate discovery.
- Pattern Activation: The AWS KMS Key discovery pattern is disabled by default and must be enabled. From Visibility Content version 6.28.0 onward, activating or deactivating patterns is not considered customization, ensuring patterns update automatically after upgrades.
- Data Population: Running the “Amazon AWS - KMS Key - Extended Inventory (LP)” pattern populates AWS KMS Key data in:
- Non-CMDB tables, accessible via All > Configuration > AWS, for detailed inventory data.
- CMDB tables, specifically the Cloud Resource [cmdbcicmpresource] table, which holds key attributes like ARN, resource type, install status, and operational status.
- Key Fields Captured: Important fields include the Amazon Resource Name (ARN), Key ID, Key State (e.g., Enabled, Disabled, PendingDeletion), and configuration item references.
- CI Relationships and References: The pattern establishes relationships such as “Hosted on::Hosts” linking the Cloud Resource to the AWS Datacenter, and references between AWS KMS Key records and Cloud Resource records to maintain data integrity.
- AWS Tag Discovery: Tags associated with AWS KMS Keys are collected and stored in the Key Value [cmdbkeyvalue] table, tied back to the Cloud Resource record for enhanced asset management and categorization.
Practical Benefits for ServiceNow Customers
- Automates discovery and continuous updating of AWS KMS Keys within the ServiceNow CMDB and non-CMDB data structures.
- Ensures comprehensive visibility into AWS KMS Key configurations, states, and associated metadata, improving cloud security and compliance management.
- Provides a structured and relational view of AWS KMS Keys, supporting operational workflows and integrations.
- Facilitates tag-based resource management by capturing AWS tags as key-value pairs linked to configuration items.
Discovery and Service Mapping Patterns finds AWS KMS Keys 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.
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 - KMS Key - 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) of the KMS Key. |
| Name [name] | The ARN of the KMS Key. |
| Arn [arn] | The ARN of the KMS Key. |
| Key ID [key_id] | The unique identifier of the KMS Key. |
| Key State [key_state] | The current state of the KMS Key. For example: Enabled, Disabled, or PendingDeletion. |
| 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 - KMS Key - Extended Inventory (LP) pattern.
| Field | Description |
|---|---|
| Name [name] | The ARN of the KMS Key. |
| Object ID [object_id] | The ARN of the KMS Key. |
| Resource type [resource_type] | Type of resource. The value is set to AWS::KMS::Key. |
| 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 - KMS Key - Extended Inventory (LP) pattern creates the following relationships and references to support AWS KMS Key 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 KMS Key [cmdb_aws_kms_key] | 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 - KMS Key - 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. |