Amazon Athena Workgroup pattern-based discovery
Summarize
Summary of Amazon Athena Workgroup pattern-based discovery
This discovery pattern identifies Amazon Athena Workgroups within your AWS cloud environment using the Discovery and Service Mapping Patterns application. It requires certain AWS discovery prerequisites and proper configuration to avoid duplicate resource discovery.
Show less
Key Features
- Prerequisites: Ensure AWS discovery prerequisites are met per the Amazon AWS Cloud components discovery documentation.
- Resource Inclusion List: Remove any Athena Workgroup entries from the Resource Inclusion List [sacloudinventoryresourcewhitelist] table to prevent duplicates.
- Pattern Activation: The Athena Workgroup pattern is disabled by default. Enabling or disabling patterns starting with Visibility Content version 6.28.0 will not be treated as customizations and patterns will reset to the latest predefined version upon upgrade, preserving the last active status.
- Data Storage: Discovery results populate both CMDB and non-CMDB tables:
- Non-CMDB data is collected when running the Amazon AWS - Athena Workgroup - Extended Inventory (LP) pattern and can be viewed under All > Configuration > AWS.
- CMDB tables store detailed resource information including workgroup configuration items and relationships.
- CI Relationships and References: The pattern creates relationships such as "Hosted on::Hosts" linking Athena Workgroups to AWS Datacenters and references between Athena Workgroup records and Cloud Resources.
- Tag Collection: AWS tags associated with Athena Workgroups are discovered and stored in the Key Value [cmdbkeyvalue] table, linked back to the Cloud Resource configuration item.
Key Outcomes
- Comprehensive discovery and inventory of Amazon Athena Workgroups within your AWS environment.
- Accurate and up-to-date configuration items representing Athena Workgroups in your CMDB, supporting operational management and reporting.
- Clear resource relationships and tagging information to enhance visibility, governance, and automation capabilities.
- Seamless updates and pattern management without losing configuration on upgrades, ensuring discovery remains current and consistent.
Discovery and Service Mapping Patterns finds Amazon Athena Workgroups 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.
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 - Athena Workgroup - 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 Amazon Athena workgroup. |
| Object ID [object_id] | Amazon Resource Name (ARN) that uniquely identifies the workgroup. |
| State [state] | Current state of the workgroup. For example: ENABLED or DISABLED. |
| Effective Engine Version [effective_engine_version] | Engine version used by the workgroup to process queries. |
| Configuration Item [configuration_item] | References the Cloud Resource [cmdb_ci_cmp_resource] table. |
Data stored in CMDB tables
Discovery and Service Mapping Patterns application populates data in the CMDB when running the Amazon AWS - Athena Workgroup - Extended Inventory (LP) pattern.
| Field | Description |
|---|---|
| Object ID [object_id] | ARN that uniquely identifies the workgroup. |
| Name [name] | Name of the AmazonAmazon Athena workgroup. |
| Resource type [resource_type] | Resource type. The value is set to AWS::Athena::Workgroup. |
| Operational status [operational_status] | Operational status of the resource. Default value is Operational. |
| Install Status [install_status] | Install status of the resource. Default value is Installed. |
CI relationships
The Amazon AWS - Athena Workgroup - Extended Inventory (LP) pattern creates the following relationships and references to support Amazon Athena Workgroup discovery. References link to records in other tables and don't appear in the CI Relationship [cmdb_rel_ci] table.
| CI | Relationship | CI |
|---|---|---|
| Cloud Resource [cmdb_ci_cmp_resource] | Hosted on::Hosts | AWS Datacenter [cmdb_ci_aws_datacenter] |
| CI | Field | Referenced CI |
|---|---|---|
| AWS Athena Workgroup [cmdb_aws_athena_workgroup] | Configuration Item [configuration_item] | Cloud Resource [cmdb_ci_cmp_resource] |
| Key Value [cmdb_key_value] | Configuration item [configuration_item] | Cloud Resource [cmdb_ci_cmp_resource] |
AWS Tag discovery
The Amazon AWS - Athena Workgroup - 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 Resource [cmdb_ci_cmp_resource] table. |