AWS Step Functions State Machine pattern-based discovery
Summarize
Summary of AWS Step Functions State Machine pattern-based discovery
This capability enables ServiceNow customers to discover AWS Step Functions State Machines in their cloud environments using Discovery and Service Mapping Patterns. It supports detailed inventory collection for both AWS Standard and Express state machines, populating data into the Configuration Management Database (CMDB) and associated non-CMDB tables.
Show less
Prerequisites and Setup
- Ensure AWS discovery prerequisites are met, including proper AWS service account configuration.
- Remove any relevant resources from the Resource Inclusion List to prevent duplicate discoveries.
- Enable the AWS Step Functions State Machine pattern, which is disabled by default. From Visibility Content version 6.28.0 onward, pattern enablement is preserved through updates without being treated as customizations.
- For AWS GovCloud (US) discovery, configure discovery schedules to use the appropriate datacenter URLs.
Data Storage and Tables
Discovery populates data in both CMDB and non-CMDB tables as part of the Extended Inventory (LP) pattern for AWS Step Functions State Machines:
- Non-CMDB Table:
cmdbawsstepfunctionsstatemachinestores key fields such as name, Amazon Resource Name (ARN), type (STANDARD or EXPRESS), and references to the corresponding cloud function. - CMDB Table:
cmdbcicloudfunctionstores detailed information about each state machine including name, ARN, edition, install status (default Installed), and operational status (default Operational).
CI Relationships and References
The discovery pattern automatically creates relationships to support data integrity and context:
- CI Relationships: Links cloud functions hosting the state machines to the AWS datacenter (
cmdbciawsdatacenter). - CI References: Connects state machine records to their cloud function entries and associated key-value pairs.
AWS Tag Collection
The pattern collects AWS tags on discovered state machines and stores them in the cmdbkeyvalue table. Tags include key names and values linked back to the cloud function records, enabling tag-based filtering and management within ServiceNow.
Discovery and Service Mapping Patterns finds AWS Step Functions State Machines 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 - Step Functions State Machine - 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] | Name of the state machine. |
| Object ID [object_id] | The Amazon Resource Name (ARN) of the state machine. |
| Type [type] | Type of the state machine. The value is STANDARD or EXPRESS. |
| Configuration Item [configuration_item] | References the Cloud Function [cmdb_ci_cloud_function] table. |
Data stored in CMDB tables
Discovery and Service Mapping Patterns application populates data in the CMDB when running the Amazon AWS - Step Functions State Machine - Extended Inventory (LP) pattern.
| Field | Description |
|---|---|
| Name [name] | Name of the state machine. |
| Object ID [object_id] | The ARN of the state machine. |
| Edition [edition] | Type of the state machine. The value is STANDARD or EXPRESS. |
| 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 - Step Functions State Machine - Extended Inventory (LP) pattern creates the following relationships and references to support AWS Step Functions State Machine discovery. References link to records in other tables and don't appear in the CI Relationship [cmdb_rel_ci] table.
| CI | Relationship | CI |
|---|---|---|
| Cloud Function [cmdb_ci_cloud_function] | Hosted on::Hosts | AWS Datacenter [cmdb_ci_aws_datacenter] |
| CI | Field | Referenced CI |
|---|---|---|
| AWS Step Functions State Machine [cmdb_aws_step_functions_state_machine] | Configuration Item [configuration_item] | Cloud Function [cmdb_ci_cloud_function] |
| Key Value [cmdb_key_value] | Configuration item [configuration_item] | Cloud Function [cmdb_ci_cloud_function] |
AWS Tag discovery
The Amazon AWS - Step Functions State Machine - 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 Function [cmdb_ci_cloud_function] table. |