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 cloud environments. This discovery uses the Discovery and Service Mapping Patterns application, which requires specific AWS prerequisites and pattern configurations. It supports populating data into both CMDB and non-CMDB tables, helping maintain an accurate and comprehensive configuration management database for AWS CloudHSM resources.
Show less
Key Features
- Pattern Activation: The AWS CloudHSM HSM discovery pattern is disabled by default and must be enabled explicitly. Starting with Visibility Content version 6.28.0, enabling or disabling patterns is not treated as customization, ensuring ongoing updates and reset to the latest versions after upgrades.
- Prerequisites: Customers must verify AWS discovery prerequisites and remove any relevant resources from the Resource Inclusion List table to avoid duplicate discoveries.
- GovCloud Support: Discovery of AWS GovCloud (US) accounts requires configuring the discovery schedule using a datacenter URL specific to GovCloud service accounts.
- Data Storage: The discovery populates detailed HSM data into both non-CMDB tables (such as
cmdbawscloudhsmhsm) and CMDB tables (such ascmdbcicmpresource), providing comprehensive resource details and statuses. - CI Relationships: The pattern automatically creates relationships between discovered CloudHSM HSMs, AWS datacenters, and cloud resources to support accurate dependency mapping within the CMDB.
Key Outcomes
- Accurate identification and tracking of AWS CloudHSM HSM devices including their unique names, availability zones, operational statuses, cluster IDs, and device types.
- Automatic population and updating of AWS CloudHSM HSM data in ServiceNow CMDB and non-CMDB tables, enabling better asset management and operational insight.
- Improved visibility into AWS CloudHSM infrastructure with established CI relationships that support service mapping and impact analysis.
- Seamless updates to discovery patterns without losing configuration, ensuring ongoing alignment with AWS resource changes and ServiceNow platform upgrades.
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] |