Amazon SageMaker Notebook Instance pattern-based discovery
Summarize
Summary of Amazon SageMaker Notebook Instance pattern-based discovery
The Amazon SageMaker Notebook Instance pattern-based discovery enables ServiceNow customers to discover and map Amazon SageMaker Notebook Instances within their AWS cloud environments. This capability is part of the Discovery and Service Mapping Patterns application and requires updating to the latest version to ensure effective discovery of these resources.
Show less
Prerequisites and Setup
- AWS Discovery Prerequisites: Customers must verify AWS discovery prerequisites as outlined in the Amazon AWS Cloud components discovery documentation.
- Resource Inclusion List: To prevent duplicate discovery, ensure the target notebook instances are not listed in the Resource Inclusion List [sacloudinventoryresourcewhitelist] table.
- Pattern Activation: The SageMaker Notebook Instance discovery pattern is disabled by default. Starting with Visibility Content version 6.28.0, enabling or disabling patterns no longer counts as customization and patterns will auto-reset to the latest version after upgrades while preserving activation status.
Data Collection and Storage
The discovery process populates data in both CMDB and non-CMDB tables, providing comprehensive visibility into SageMaker Notebook Instances.
Non-CMDB Data
- Data gathered by the Amazon AWS - SageMaker Notebook Instance - Extended Inventory (LP) pattern is stored in non-CMDB AWS-specific tables accessible under All > Configuration > AWS.
- The cmdbawssagemakernotebookinstance table captures key properties such as notebook name, Amazon Resource Name (ARN), instance status, encryption key ID, default code repository, root access status, and links to the associated Cloud Resource record.
CMDB Data
- The same pattern populates the Cloud Resource [cmdbcicmpresource] table with core CI information including name, ARN, resource type (AWS::SageMaker::NotebookInstance), install status, and operational status.
Configuration Item Relationships and References
- The pattern establishes relationships between the SageMaker Notebook Instance CI and the hosting AWS Datacenter, supporting cloud infrastructure context.
- References exist between the SageMaker notebook instance records and corresponding Cloud Resource records, enabling traceability within CMDB data.
AWS Tag Discovery
The pattern also collects AWS tags associated with SageMaker Notebook Instances and stores them in the Key Value [cmdbkeyvalue] table, linking tags back to the relevant Cloud Resource. This supports tag-based filtering and management within ServiceNow.
Practical Benefits for ServiceNow Customers
- Automated and accurate discovery of Amazon SageMaker Notebook Instances improves cloud asset visibility.
- Data stored in both CMDB and non-CMDB tables supports enriched configuration management and operational insight.
- Tag collection enables better governance and resource categorization.
- Relationship mapping integrates SageMaker instances into the broader AWS infrastructure model.
- Pattern activation and updates are streamlined, ensuring customers benefit from the latest enhancements without manual customization risks.
Discovery and Service Mapping Patterns finds Amazon SageMaker Notebook Instances 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 - SageMaker Notebook Instance - 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 notebook instance. |
| Object ID [object_id] | The Amazon Resource Name (ARN) of the notebook instance. |
| Instance Status [instance_status] | The current status of the notebook instance. For example: InService, Pending, Stopped, Stopping, or Failed. |
| Kms Key Id [kms_key_id] | The ARN of the AWS KMS key used to encrypt the notebook instance's storage volume. This field is empty if no KMS key is configured. |
| Default Code Repository [default_code_repository] | The name or URL of the Git repository associated with the notebook instance as its default code repository. |
| Root Access [root_access] | Indicates whether root access is enabled for the notebook instance. The value is Enabled or Disabled. |
| 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 - SageMaker Notebook Instance - Extended Inventory (LP) pattern.
| Field | Description |
|---|---|
| Name [name] | Name of the notebook instance. |
| Object ID [object_id] | The ARN of the notebook instance. |
| Resource type [resource_type] | Type of resource. The value is set to AWS::SageMaker::NotebookInstance. |
| 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 - SageMaker Notebook Instance - Extended Inventory (LP) pattern creates the following relationships and references to support Amazon SageMaker Notebook Instance 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 SageMaker Notebook Instance [cmdb_aws_sagemaker_notebook_instance] | 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 - SageMaker Notebook Instance - 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. |