[Backport 2.17] Add Data connection saved-object type for external connections

changelogs/fragments/7925.yml

@@ -0,0 +1,2 @@
+feat:
+- Introduce a data-connection saved-object type for external data connections ([#7925](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/7925))

src/plugins/data_source/common/data_connections/data_connection_saved_object_attributes.ts

@@ -0,0 +1,28 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { SavedObjectAttributes } from 'src/core/types';
+
+export const DATA_CONNECTION_SAVED_OBJECT_TYPE = 'data-connection';
+
+/**
+ * Represents the attributes of a data connection saved object.
+ * @property connectionId: The name of the data connection.
+ * @property type: The type of the data connection based on enum DataConnectionType
+ * @property meta: Additional metadata associated with the data connection.
+ */
+export interface DataConnectionSavedObjectAttributes extends SavedObjectAttributes {
+  connectionId: string;
+  type: DataConnectionType;
+  meta?: string;
+}
+
+export enum DataConnectionType {
+  CloudWatch = 'AWS CloudWatch',
+  SecurityLake = 'AWS Security Lake',
+  NA = 'None',
+}
+
+export const DATA_CONNECTION_ID_LENGTH_LIMIT = 32;

src/plugins/data_source/common/data_connections/index.ts

@@ -0,0 +1,6 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+export * from './data_connection_saved_object_attributes';

src/plugins/data_source/server/plugin.ts

@@ -22,7 +22,7 @@ import { DataSourcePluginConfigType } from '../config';
 import { LoggingAuditor } from './audit/logging_auditor';
 import { CryptographyService, CryptographyServiceSetup } from './cryptography_service';
 import { DataSourceService, DataSourceServiceSetup } from './data_source_service';
-import { DataSourceSavedObjectsClientWrapper, dataSource } from './saved_objects';
+import { dataConnection, dataSource, DataSourceSavedObjectsClientWrapper } from './saved_objects';
 import { AuthenticationMethod, DataSourcePluginSetup, DataSourcePluginStart } from './types';
 import { DATA_SOURCE_SAVED_OBJECT_TYPE } from '../common';
 
@@ -55,6 +55,7 @@ export class DataSourcePlugin implements Plugin<DataSourcePluginSetup, DataSourc
 
     // Register data source saved object type
     core.savedObjects.registerType(dataSource);
+    core.savedObjects.registerType(dataConnection);
 
     const config: DataSourcePluginConfigType = await this.config$.pipe(first()).toPromise();
 

src/plugins/data_source/server/saved_objects/data_connection.ts

@@ -0,0 +1,32 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { SavedObjectsType } from 'opensearch-dashboards/server';
+
+export const dataConnection: SavedObjectsType = {
+  name: 'data-connection',
+  namespaceType: 'agnostic',
+  hidden: false,
+  management: {
+    icon: 'apps',
+    defaultSearchField: 'connectionId',
+    importableAndExportable: true,
+  },
+  mappings: {
+    dynamic: false,
+    properties: {
+      connectionId: {
+        type: 'text',
+      },
+      type: {
+        type: 'text',
+      },
+      meta: {
+        type: 'text',
+      },
+    },
+  },
+  migrations: {},
+};

src/plugins/data_source/server/saved_objects/index.ts

@@ -5,3 +5,5 @@
 
 export { dataSource } from './data_source';
 export { DataSourceSavedObjectsClientWrapper } from './data_source_saved_objects_client_wrapper';
+
+export { dataConnection } from './data_connection';