AWS Step Functions State Machine pattern-based discovery
Summarize
Summary of AWS Step Functions State Machine pattern-based discovery
This pattern-based discovery enables ServiceNow customers to find and map AWS Step Functions State Machines within their cloud environments using the Discovery and Service Mapping Patterns application. By leveraging this pattern, customers can automate identification and integration of AWS Step Functions resources into their CMDB and related tables, improving visibility and management of these AWS services.
Show less
Key Features
- Pattern Activation: The AWS Step Functions State Machine pattern is disabled by default and must be enabled. Starting with Visibility Content version 6.28.0, enabling or disabling patterns does not count as customization, ensuring continued updates without losing configuration.
- Discovery Prerequisites: Customers must verify AWS discovery prerequisites and ensure that the relevant resources are not listed in the Resource Inclusion List table to prevent duplicate discovery.
- Support for AWS GovCloud: When discovering AWS GovCloud (US) accounts, configuration of the AWS service account with a datacenter URL is necessary.
- Data Storage: Discovery populates data into both CMDB and non-CMDB tables. Non-CMDB AWS tables can be reviewed through the ServiceNow interface under Configuration > AWS.
- Comprehensive Data Model: The discovery collects detailed fields such as state machine name, ARN (object ID), type (STANDARD or EXPRESS), install and operational status, and relationships to other configuration items.
- CI Relationships and References: The pattern establishes relationships like "Hosted on" between Cloud Functions and AWS Datacenters, and references between AWS Step Functions State Machines and Cloud Functions for accurate mapping.
- AWS Tag Collection: Tags associated with AWS Step Functions are collected and stored in the Key Value table, supporting enhanced filtering and reporting capabilities.
Key Outcomes
- Automated discovery and accurate representation of AWS Step Functions State Machines within the ServiceNow CMDB and supporting tables.
- Improved cloud resource visibility, enabling better operational status monitoring and management of AWS Step Functions.
- Elimination of duplicate discovery issues by managing resource inclusion lists effectively.
- Support for AWS GovCloud environments ensuring compliance with regional cloud deployments.
- Enables customers to maintain up-to-date information on AWS Step Functions through pattern updates without losing customizations.
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 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 - 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. |