AWS CloudHSM HSM pattern-based discovery
Summarize
Summary of AWS CloudHSM HSM pattern-based discovery
The AWS CloudHSM HSM pattern-based discovery feature in ServiceNow enables automated identification and inventory of AWS CloudHSM hardware security modules (HSMs) within your AWS environment. This discovery is part of the Discovery and Service Mapping Patterns application, which helps populate both CMDB and non-CMDB tables with accurate AWS resource data. It facilitates comprehensive visibility and management of CloudHSM resources, including their configurations and operational status.
Show less
Key Features
- Pattern Activation: The AWS CloudHSM HSM discovery pattern is disabled by default and requires manual activation. Enabling or disabling patterns no longer counts as a customization and patterns reset to the latest version after upgrades while preserving activation status.
- Prerequisites: Customers must verify AWS discovery prerequisites and ensure relevant resources are not listed in the Resource Inclusion List to avoid duplicate discoveries.
- Support for AWS GovCloud: Discovery of AWS GovCloud accounts requires configuration of datacenter URLs during AWS service account setup.
- Data Population: Discovery populates detailed HSM data in both CMDB and non-CMDB tables, providing a structured view of hardware security modules and their relationships within the AWS environment.
- CI Relationships: The pattern automatically creates relationships linking CloudHSM HSMs to their hosting AWS datacenters and corresponding cloud resources for integrated configuration management.
Key Outcomes
- Comprehensive Inventory: Customers gain an accurate and up-to-date inventory of AWS CloudHSM HSMs, including identifiers, availability zones, cluster IDs, types, and operational status.
- CMDB Enrichment: Discovered HSMs are represented as configuration items in the CMDB with standardized fields such as resource type, install status, operational status, and ARN-based object IDs.
- Enhanced Visibility and Control: The discovery pattern supports ongoing management and operational oversight of CloudHSM devices through established CI relationships and detailed resource data.
- Upgrade Friendly: Pattern activations are preserved across upgrades, ensuring continuous discovery without loss of configuration.
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 - CloudHSM HSM - 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 unique identifier of the HSM within the cluster. |
| Availability Zone [availability_zone] | The AWS availability zone where the HSM is deployed. |
| Status [status] | The current operational status of the HSM. |
| Cluster Id [cluster_id] | The unique identifier of the HSM cluster. |
| Configuration Item [configuration_item] | References the Cloud Resource [cmdb_ci_cmp_resource] table. |
| Hsm Type [hsm_type] | The type or model specification of the HSM device. |
| Object Id [object_id] | The Amazon Resource Name (ARN) uniquely identifying the AWS CloudHSM HSM. The ARN consists of the discovered region, account ID, and HSM ID in the following format: arn:aws:cloudhsm:<region>:<account_id>:hsm/<hsm_id>. |
Data stored in CMDB tables
Discovery and Service Mapping Patterns application populates data in the CMDB when running the Amazon AWS - CloudHSM HSM - Extended Inventory (LP) pattern.
| Field | Description |
|---|---|
| Name [name] | The unique identifier of the HSM within the cluster. |
| Resource type [resource_type] | Type of resource. The value is set to AWS::CloudHSM::HSM. |
| Install Status [install_status] | Install status of the resource. Default value is Installed. |
| Object ID [object_id] | The ARN uniquely identifying the AWS CloudHSM HSM. The ARN consists of the discovered region, account ID, and HSM ID in the following format: arn:aws:cloudhsm:<region>:<account_id>:hsm/<hsm_id>. |
| Operational status [operational_status] | Operational status of the resource. Default value is Operational. |
CI relationships
The Amazon AWS - CloudHSM HSM - Extended Inventory (LP) pattern creates these relationships to support AWS CloudHSM HSM discovery.
| CI | Relationship | CI |
|---|---|---|
| Cloud Resource [cmdb_ci_cmp_resource] | Hosted on::Hosts | AWS Datacenter [cmdb_ci_aws_datacenter] |
| AWS CloudHSM HSM [cmdb_aws_cloudhsm_hsm] | References | Cloud Resource [cmdb_ci_cmp_resource] |