AWS CloudHSM HSM pattern-based discovery
Summarize
Summary of AWS CloudHSM HSM pattern-based discovery
The AWS CloudHSM HSM pattern-based discovery enables ServiceNow customers to identify and map AWS CloudHSM hardware security modules (HSMs) within their AWS cloud environments using Discovery and Service Mapping Patterns. This process populates both CMDB and non-CMDB tables, providing detailed configuration and operational data about CloudHSM resources to support asset and configuration management.
Show less
Key Features
- Prerequisites and Setup: Customers must verify AWS discovery prerequisites and ensure relevant resources are not listed in the Resource Inclusion List to avoid duplicate discovery.
- Pattern Activation: The AWS CloudHSM HSM discovery pattern is disabled by default and must be enabled. Activating or deactivating patterns no longer counts as customization and patterns reset to predefined versions after upgrades.
- Discovery Scheduling for GovCloud: For AWS GovCloud regions, discovery requires configuration using a datacenter URL when creating AWS service accounts.
- Data Population: The discovery populates detailed CloudHSM information in:
- Non-CMDB AWS tables (e.g.,
cmdbawscloudhsmhsm) capturing fields such as HSM name, availability zone, status, cluster ID, HSM type, and Amazon Resource Name (ARN). - CMDB tables (e.g.,
cmdbcicmpresource) storing resource name, type, install and operational status, and ARN. - CI Relationships: The pattern creates relationships linking CloudHSM resources to AWS datacenters and Cloud Resources, supporting comprehensive configuration management.
What Customers Can Expect
By enabling and running the AWS CloudHSM HSM discovery pattern, customers gain accurate, up-to-date visibility into their CloudHSM assets with detailed attributes and operational status. This supports effective asset tracking, compliance, and security management within the ServiceNow CMDB. The pattern’s integration with both CMDB and non-CMDB tables allows flexible data usage and reporting.
Additionally, the automatic management of pattern versions during upgrades ensures customers maintain access to the latest discovery capabilities without losing prior configuration states.
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 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.
- 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] |