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 automatically detect 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 adherence to AWS discovery prerequisites and proper configuration to avoid duplicate discoveries.
Show less
Enabling and Requirements
- AWS Prerequisites: Customers must verify AWS discovery prerequisites as outlined in the AWS discovery using patterns documentation.
- Resource Inclusion List: Ensure SageMaker Notebook Instances are not listed in the Resource Inclusion List to prevent duplicated discovery entries.
- Pattern Activation: The SageMaker Notebook Instance discovery pattern is disabled by default. From Visibility Content version 6.28.0 onward, activating or deactivating this pattern does not count as a customization and updates will continue after upgrades.
Data Collection and Storage
Discovery populates data into both CMDB and non-CMDB tables:
- Non-CMDB Tables: When running the “Amazon AWS - SageMaker Notebook Instance - Extended Inventory (LP)” pattern, detailed SageMaker instance data is stored in non-CMDB AWS tables accessible via the Configuration > AWS module.
- CMDB Tables: Core resource information is stored in the Cloud Resource [cmdbcicmpresource] table, representing the SageMaker Notebook Instances as configuration items (CIs).
Key Data Fields
- Non-CMDB Table [cmdbawssagemakernotebookinstance]: Captures instance name, ARN (object ID), status (e.g., InService, Stopped), KMS key ID if encryption is used, default code repository URL or name, root access status, and a reference to the corresponding Cloud Resource CI.
- CMDB Table [cmdbcicmpresource]: Stores the notebook instance name, ARN, resource type (AWS::SageMaker::NotebookInstance), install and operational status.
CI Relationships and References
- The pattern establishes a Hosted on::Hosts relationship linking the SageMaker Notebook Instance CI to an AWS Datacenter CI, supporting accurate service mapping.
- References connect SageMaker Notebook Instances in non-CMDB tables to their corresponding CIs in the CMDB for consistent data integrity.
AWS Tag Discovery
The pattern also collects AWS tags associated with SageMaker Notebook Instances and stores them in the Key Value [cmdbkeyvalue] table. Each tag includes a key (tag name), a value (tag value), and a reference to the related Cloud Resource CI, enabling enhanced filtering and reporting based on tags.
Practical Benefits for ServiceNow Customers
- Automates detection and inventory of SageMaker Notebook Instances, reducing manual effort.
- Provides comprehensive, up-to-date information about instance status, configuration, and security settings such as encryption and root access.
- Integrates AWS resource data into the ServiceNow CMDB, facilitating unified cloud asset management and service mapping.
- Supports accurate relationship mapping and tagging, improving visibility and governance of AWS SageMaker resources within ServiceNow.
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 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.
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. |