1. Packages
  2. Packages
  3. Oracle Cloud Infrastructure
  4. API Docs
  5. GenerativeAi
  6. SemanticStore
Viewing docs for Oracle Cloud Infrastructure v4.10.0
published on Thursday, May 7, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-oci

oci.GenerativeAi.SemanticStore

oci logo
Viewing docs for Oracle Cloud Infrastructure v4.10.0
published on Thursday, May 7, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-oci

    This resource provides the Semantic Store resource in Oracle Cloud Infrastructure Generative AI service. Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/generative-ai/latest/SemanticStore

    Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/generative_ai

    Creates a SemanticStore.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testSemanticStore = new oci.generativeai.SemanticStore("test_semantic_store", {
    compartmentId: compartmentId,
    dataSource: {
        connectionType: semanticStoreDataSourceConnectionType,
        enrichmentConnectionId: testConnection.id,
        queryingConnectionId: testConnection.id,
    },
    displayName: semanticStoreDisplayName,
    schemas: {
        connectionType: semanticStoreSchemasConnectionType,
        schemas: [{
            name: semanticStoreSchemasSchemasName,
        }],
    },
    definedTags: {
        "Operations.CostCenter": "42",
    },
    description: semanticStoreDescription,
    freeformTags: {
        Department: "Finance",
    },
    refreshSchedule: {
        type: semanticStoreRefreshScheduleType,
        value: semanticStoreRefreshScheduleValue,
    },
});

    import pulumi
import pulumi_oci as oci

test_semantic_store = oci.generativeai.SemanticStore("test_semantic_store",
    compartment_id=compartment_id,
    data_source={
        "connection_type": semantic_store_data_source_connection_type,
        "enrichment_connection_id": test_connection["id"],
        "querying_connection_id": test_connection["id"],
    },
    display_name=semantic_store_display_name,
    schemas={
        "connection_type": semantic_store_schemas_connection_type,
        "schemas": [{
            "name": semantic_store_schemas_schemas_name,
        }],
    },
    defined_tags={
        "Operations.CostCenter": "42",
    },
    description=semantic_store_description,
    freeform_tags={
        "Department": "Finance",
    },
    refresh_schedule={
        "type": semantic_store_refresh_schedule_type,
        "value": semantic_store_refresh_schedule_value,
    })

    package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v4/go/oci/generativeai"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := generativeai.NewSemanticStore(ctx, "test_semantic_store", &generativeai.SemanticStoreArgs{
			CompartmentId: pulumi.Any(compartmentId),
			DataSource: &generativeai.SemanticStoreDataSourceArgs{
				ConnectionType:         pulumi.Any(semanticStoreDataSourceConnectionType),
				EnrichmentConnectionId: pulumi.Any(testConnection.Id),
				QueryingConnectionId:   pulumi.Any(testConnection.Id),
			},
			DisplayName: pulumi.Any(semanticStoreDisplayName),
			Schemas: &generativeai.SemanticStoreSchemasArgs{
				ConnectionType: pulumi.Any(semanticStoreSchemasConnectionType),
				Schemas: generativeai.SemanticStoreSchemasSchemaArray{
					&generativeai.SemanticStoreSchemasSchemaArgs{
						Name: pulumi.Any(semanticStoreSchemasSchemasName),
					},
				},
			},
			DefinedTags: pulumi.StringMap{
				"Operations.CostCenter": pulumi.String("42"),
			},
			Description: pulumi.Any(semanticStoreDescription),
			FreeformTags: pulumi.StringMap{
				"Department": pulumi.String("Finance"),
			},
			RefreshSchedule: &generativeai.SemanticStoreRefreshScheduleArgs{
				Type:  pulumi.Any(semanticStoreRefreshScheduleType),
				Value: pulumi.Any(semanticStoreRefreshScheduleValue),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testSemanticStore = new Oci.GenerativeAi.SemanticStore("test_semantic_store", new()
    {
        CompartmentId = compartmentId,
        DataSource = new Oci.GenerativeAi.Inputs.SemanticStoreDataSourceArgs
        {
            ConnectionType = semanticStoreDataSourceConnectionType,
            EnrichmentConnectionId = testConnection.Id,
            QueryingConnectionId = testConnection.Id,
        },
        DisplayName = semanticStoreDisplayName,
        Schemas = new Oci.GenerativeAi.Inputs.SemanticStoreSchemasArgs
        {
            ConnectionType = semanticStoreSchemasConnectionType,
            Schemas = new[]
            {
                new Oci.GenerativeAi.Inputs.SemanticStoreSchemasSchemaArgs
                {
                    Name = semanticStoreSchemasSchemasName,
                },
            },
        },
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        Description = semanticStoreDescription,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        RefreshSchedule = new Oci.GenerativeAi.Inputs.SemanticStoreRefreshScheduleArgs
        {
            Type = semanticStoreRefreshScheduleType,
            Value = semanticStoreRefreshScheduleValue,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.GenerativeAi.SemanticStore;
import com.pulumi.oci.GenerativeAi.SemanticStoreArgs;
import com.pulumi.oci.GenerativeAi.inputs.SemanticStoreDataSourceArgs;
import com.pulumi.oci.GenerativeAi.inputs.SemanticStoreSchemasArgs;
import com.pulumi.oci.GenerativeAi.inputs.SemanticStoreRefreshScheduleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var testSemanticStore = new SemanticStore("testSemanticStore", SemanticStoreArgs.builder()
            .compartmentId(compartmentId)
            .dataSource(SemanticStoreDataSourceArgs.builder()
                .connectionType(semanticStoreDataSourceConnectionType)
                .enrichmentConnectionId(testConnection.id())
                .queryingConnectionId(testConnection.id())
                .build())
            .displayName(semanticStoreDisplayName)
            .schemas(SemanticStoreSchemasArgs.builder()
                .connectionType(semanticStoreSchemasConnectionType)
                .schemas(SemanticStoreSchemasSchemaArgs.builder()
                    .name(semanticStoreSchemasSchemasName)
                    .build())
                .build())
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .description(semanticStoreDescription)
            .freeformTags(Map.of("Department", "Finance"))
            .refreshSchedule(SemanticStoreRefreshScheduleArgs.builder()
                .type(semanticStoreRefreshScheduleType)
                .value(semanticStoreRefreshScheduleValue)
                .build())
            .build());

    }
}

    resources:
  testSemanticStore:
    type: oci:GenerativeAi:SemanticStore
    name: test_semantic_store
    properties:
      compartmentId: ${compartmentId}
      dataSource:
        connectionType: ${semanticStoreDataSourceConnectionType}
        enrichmentConnectionId: ${testConnection.id}
        queryingConnectionId: ${testConnection.id}
      displayName: ${semanticStoreDisplayName}
      schemas:
        connectionType: ${semanticStoreSchemasConnectionType}
        schemas:
          - name: ${semanticStoreSchemasSchemasName}
      definedTags:
        Operations.CostCenter: '42'
      description: ${semanticStoreDescription}
      freeformTags:
        Department: Finance
      refreshSchedule:
        type: ${semanticStoreRefreshScheduleType}
        value: ${semanticStoreRefreshScheduleValue}

    Create SemanticStore Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SemanticStore(name: string, args: SemanticStoreArgs, opts?: CustomResourceOptions);
    @overload
def SemanticStore(resource_name: str,
                  args: SemanticStoreArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def SemanticStore(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  compartment_id: Optional[str] = None,
                  data_source: Optional[SemanticStoreDataSourceArgs] = None,
                  display_name: Optional[str] = None,
                  schemas: Optional[SemanticStoreSchemasArgs] = None,
                  defined_tags: Optional[Mapping[str, str]] = None,
                  description: Optional[str] = None,
                  freeform_tags: Optional[Mapping[str, str]] = None,
                  refresh_schedule: Optional[SemanticStoreRefreshScheduleArgs] = None)
    func NewSemanticStore(ctx *Context, name string, args SemanticStoreArgs, opts ...ResourceOption) (*SemanticStore, error)
    public SemanticStore(string name, SemanticStoreArgs args, CustomResourceOptions? opts = null)
    public SemanticStore(String name, SemanticStoreArgs args)
public SemanticStore(String name, SemanticStoreArgs args, CustomResourceOptions options)

    type: oci:GenerativeAi:SemanticStore
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args SemanticStoreArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SemanticStoreArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SemanticStoreArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SemanticStoreArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SemanticStoreArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var semanticStoreResource = new Oci.GenerativeAi.SemanticStore("semanticStoreResource", new()
{
    CompartmentId = "string",
    DataSource = new Oci.GenerativeAi.Inputs.SemanticStoreDataSourceArgs
    {
        ConnectionType = "string",
        EnrichmentConnectionId = "string",
        QueryingConnectionId = "string",
    },
    DisplayName = "string",
    Schemas = new Oci.GenerativeAi.Inputs.SemanticStoreSchemasArgs
    {
        ConnectionType = "string",
        Schemas = new[]
        {
            new Oci.GenerativeAi.Inputs.SemanticStoreSchemasSchemaArgs
            {
                Name = "string",
            },
        },
    },
    DefinedTags = 
    {
        { "string", "string" },
    },
    Description = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    RefreshSchedule = new Oci.GenerativeAi.Inputs.SemanticStoreRefreshScheduleArgs
    {
        Type = "string",
        Value = "string",
    },
});

    example, err := generativeai.NewSemanticStore(ctx, "semanticStoreResource", &generativeai.SemanticStoreArgs{
	CompartmentId: pulumi.String("string"),
	DataSource: &generativeai.SemanticStoreDataSourceArgs{
		ConnectionType:         pulumi.String("string"),
		EnrichmentConnectionId: pulumi.String("string"),
		QueryingConnectionId:   pulumi.String("string"),
	},
	DisplayName: pulumi.String("string"),
	Schemas: &generativeai.SemanticStoreSchemasArgs{
		ConnectionType: pulumi.String("string"),
		Schemas: generativeai.SemanticStoreSchemasSchemaArray{
			&generativeai.SemanticStoreSchemasSchemaArgs{
				Name: pulumi.String("string"),
			},
		},
	},
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	RefreshSchedule: &generativeai.SemanticStoreRefreshScheduleArgs{
		Type:  pulumi.String("string"),
		Value: pulumi.String("string"),
	},
})

    var semanticStoreResource = new SemanticStore("semanticStoreResource", SemanticStoreArgs.builder()
    .compartmentId("string")
    .dataSource(SemanticStoreDataSourceArgs.builder()
        .connectionType("string")
        .enrichmentConnectionId("string")
        .queryingConnectionId("string")
        .build())
    .displayName("string")
    .schemas(SemanticStoreSchemasArgs.builder()
        .connectionType("string")
        .schemas(SemanticStoreSchemasSchemaArgs.builder()
            .name("string")
            .build())
        .build())
    .definedTags(Map.of("string", "string"))
    .description("string")
    .freeformTags(Map.of("string", "string"))
    .refreshSchedule(SemanticStoreRefreshScheduleArgs.builder()
        .type("string")
        .value("string")
        .build())
    .build());

    semantic_store_resource = oci.generativeai.SemanticStore("semanticStoreResource",
    compartment_id="string",
    data_source={
        "connection_type": "string",
        "enrichment_connection_id": "string",
        "querying_connection_id": "string",
    },
    display_name="string",
    schemas={
        "connection_type": "string",
        "schemas": [{
            "name": "string",
        }],
    },
    defined_tags={
        "string": "string",
    },
    description="string",
    freeform_tags={
        "string": "string",
    },
    refresh_schedule={
        "type": "string",
        "value": "string",
    })

    const semanticStoreResource = new oci.generativeai.SemanticStore("semanticStoreResource", {
    compartmentId: "string",
    dataSource: {
        connectionType: "string",
        enrichmentConnectionId: "string",
        queryingConnectionId: "string",
    },
    displayName: "string",
    schemas: {
        connectionType: "string",
        schemas: [{
            name: "string",
        }],
    },
    definedTags: {
        string: "string",
    },
    description: "string",
    freeformTags: {
        string: "string",
    },
    refreshSchedule: {
        type: "string",
        value: "string",
    },
});

    type: oci:GenerativeAi:SemanticStore
properties:
    compartmentId: string
    dataSource:
        connectionType: string
        enrichmentConnectionId: string
        queryingConnectionId: string
    definedTags:
        string: string
    description: string
    displayName: string
    freeformTags:
        string: string
    refreshSchedule:
        type: string
        value: string
    schemas:
        connectionType: string
        schemas:
            - name: string

    SemanticStore Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The SemanticStore resource accepts the following input properties:

    CompartmentId string
    (Updatable) Owning compartment OCID for a SemanticStore.
    DataSource SemanticStoreDataSource
    Defines the data source that the semantic model connects to.
    DisplayName string
    (Updatable) A user-friendly name.
    Schemas SemanticStoreSchemas
    (Updatable) Array of database schemas or other database objects to include in enrichment pipeline.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) An optional description of the SemanticStore.
    FreeformTags Dictionary<string, string>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    RefreshSchedule SemanticStoreRefreshSchedule
    (Updatable) Specifies a refresh schedule. Null represents no automated synchronization schedule.
    CompartmentId string
    (Updatable) Owning compartment OCID for a SemanticStore.
    DataSource SemanticStoreDataSourceArgs
    Defines the data source that the semantic model connects to.
    DisplayName string
    (Updatable) A user-friendly name.
    Schemas SemanticStoreSchemasArgs
    (Updatable) Array of database schemas or other database objects to include in enrichment pipeline.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) An optional description of the SemanticStore.
    FreeformTags map[string]string
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    RefreshSchedule SemanticStoreRefreshScheduleArgs
    (Updatable) Specifies a refresh schedule. Null represents no automated synchronization schedule.
    compartmentId String
    (Updatable) Owning compartment OCID for a SemanticStore.
    dataSource SemanticStoreDataSource
    Defines the data source that the semantic model connects to.
    displayName String
    (Updatable) A user-friendly name.
    schemas SemanticStoreSchemas
    (Updatable) Array of database schemas or other database objects to include in enrichment pipeline.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) An optional description of the SemanticStore.
    freeformTags Map<String,String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    refreshSchedule SemanticStoreRefreshSchedule
    (Updatable) Specifies a refresh schedule. Null represents no automated synchronization schedule.
    compartmentId string
    (Updatable) Owning compartment OCID for a SemanticStore.
    dataSource SemanticStoreDataSource
    Defines the data source that the semantic model connects to.
    displayName string
    (Updatable) A user-friendly name.
    schemas SemanticStoreSchemas
    (Updatable) Array of database schemas or other database objects to include in enrichment pipeline.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description string
    (Updatable) An optional description of the SemanticStore.
    freeformTags {[key: string]: string}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    refreshSchedule SemanticStoreRefreshSchedule
    (Updatable) Specifies a refresh schedule. Null represents no automated synchronization schedule.
    compartment_id str
    (Updatable) Owning compartment OCID for a SemanticStore.
    data_source SemanticStoreDataSourceArgs
    Defines the data source that the semantic model connects to.
    display_name str
    (Updatable) A user-friendly name.
    schemas SemanticStoreSchemasArgs
    (Updatable) Array of database schemas or other database objects to include in enrichment pipeline.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description str
    (Updatable) An optional description of the SemanticStore.
    freeform_tags Mapping[str, str]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    refresh_schedule SemanticStoreRefreshScheduleArgs
    (Updatable) Specifies a refresh schedule. Null represents no automated synchronization schedule.
    compartmentId String
    (Updatable) Owning compartment OCID for a SemanticStore.
    dataSource Property Map
    Defines the data source that the semantic model connects to.
    displayName String
    (Updatable) A user-friendly name.
    schemas Property Map
    (Updatable) Array of database schemas or other database objects to include in enrichment pipeline.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) An optional description of the SemanticStore.
    freeformTags Map<String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    refreshSchedule Property Map
    (Updatable) Specifies a refresh schedule. Null represents no automated synchronization schedule.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SemanticStore resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    A message describing the current state in more detail that can provide actionable information.
    State string
    The lifecycle state of a SemanticStore.
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time that the SemanticStore was created in the format of an RFC3339 datetime string.
    TimeUpdated string
    The date and time that the SemanticStore was updated in the format of an RFC3339 datetime string.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    A message describing the current state in more detail that can provide actionable information.
    State string
    The lifecycle state of a SemanticStore.
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time that the SemanticStore was created in the format of an RFC3339 datetime string.
    TimeUpdated string
    The date and time that the SemanticStore was updated in the format of an RFC3339 datetime string.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    A message describing the current state in more detail that can provide actionable information.
    state String
    The lifecycle state of a SemanticStore.
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time that the SemanticStore was created in the format of an RFC3339 datetime string.
    timeUpdated String
    The date and time that the SemanticStore was updated in the format of an RFC3339 datetime string.
    id string
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails string
    A message describing the current state in more detail that can provide actionable information.
    state string
    The lifecycle state of a SemanticStore.
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The date and time that the SemanticStore was created in the format of an RFC3339 datetime string.
    timeUpdated string
    The date and time that the SemanticStore was updated in the format of an RFC3339 datetime string.
    id str
    The provider-assigned unique ID for this managed resource.
    lifecycle_details str
    A message describing the current state in more detail that can provide actionable information.
    state str
    The lifecycle state of a SemanticStore.
    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The date and time that the SemanticStore was created in the format of an RFC3339 datetime string.
    time_updated str
    The date and time that the SemanticStore was updated in the format of an RFC3339 datetime string.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    A message describing the current state in more detail that can provide actionable information.
    state String
    The lifecycle state of a SemanticStore.
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time that the SemanticStore was created in the format of an RFC3339 datetime string.
    timeUpdated String
    The date and time that the SemanticStore was updated in the format of an RFC3339 datetime string.

    Look up Existing SemanticStore Resource

    Get an existing SemanticStore resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SemanticStoreState, opts?: CustomResourceOptions): SemanticStore
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        data_source: Optional[SemanticStoreDataSourceArgs] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        lifecycle_details: Optional[str] = None,
        refresh_schedule: Optional[SemanticStoreRefreshScheduleArgs] = None,
        schemas: Optional[SemanticStoreSchemasArgs] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> SemanticStore
    func GetSemanticStore(ctx *Context, name string, id IDInput, state *SemanticStoreState, opts ...ResourceOption) (*SemanticStore, error)
    public static SemanticStore Get(string name, Input<string> id, SemanticStoreState? state, CustomResourceOptions? opts = null)
    public static SemanticStore get(String name, Output<String> id, SemanticStoreState state, CustomResourceOptions options)
    resources:  _:    type: oci:GenerativeAi:SemanticStore    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CompartmentId string
    (Updatable) Owning compartment OCID for a SemanticStore.
    DataSource SemanticStoreDataSource
    Defines the data source that the semantic model connects to.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) An optional description of the SemanticStore.
    DisplayName string
    (Updatable) A user-friendly name.
    FreeformTags Dictionary<string, string>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    LifecycleDetails string
    A message describing the current state in more detail that can provide actionable information.
    RefreshSchedule SemanticStoreRefreshSchedule
    (Updatable) Specifies a refresh schedule. Null represents no automated synchronization schedule.
    Schemas SemanticStoreSchemas
    (Updatable) Array of database schemas or other database objects to include in enrichment pipeline.
    State string
    The lifecycle state of a SemanticStore.
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time that the SemanticStore was created in the format of an RFC3339 datetime string.
    TimeUpdated string
    The date and time that the SemanticStore was updated in the format of an RFC3339 datetime string.
    CompartmentId string
    (Updatable) Owning compartment OCID for a SemanticStore.
    DataSource SemanticStoreDataSourceArgs
    Defines the data source that the semantic model connects to.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) An optional description of the SemanticStore.
    DisplayName string
    (Updatable) A user-friendly name.
    FreeformTags map[string]string
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    LifecycleDetails string
    A message describing the current state in more detail that can provide actionable information.
    RefreshSchedule SemanticStoreRefreshScheduleArgs
    (Updatable) Specifies a refresh schedule. Null represents no automated synchronization schedule.
    Schemas SemanticStoreSchemasArgs
    (Updatable) Array of database schemas or other database objects to include in enrichment pipeline.
    State string
    The lifecycle state of a SemanticStore.
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time that the SemanticStore was created in the format of an RFC3339 datetime string.
    TimeUpdated string
    The date and time that the SemanticStore was updated in the format of an RFC3339 datetime string.
    compartmentId String
    (Updatable) Owning compartment OCID for a SemanticStore.
    dataSource SemanticStoreDataSource
    Defines the data source that the semantic model connects to.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) An optional description of the SemanticStore.
    displayName String
    (Updatable) A user-friendly name.
    freeformTags Map<String,String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    lifecycleDetails String
    A message describing the current state in more detail that can provide actionable information.
    refreshSchedule SemanticStoreRefreshSchedule
    (Updatable) Specifies a refresh schedule. Null represents no automated synchronization schedule.
    schemas SemanticStoreSchemas
    (Updatable) Array of database schemas or other database objects to include in enrichment pipeline.
    state String
    The lifecycle state of a SemanticStore.
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time that the SemanticStore was created in the format of an RFC3339 datetime string.
    timeUpdated String
    The date and time that the SemanticStore was updated in the format of an RFC3339 datetime string.
    compartmentId string
    (Updatable) Owning compartment OCID for a SemanticStore.
    dataSource SemanticStoreDataSource
    Defines the data source that the semantic model connects to.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description string
    (Updatable) An optional description of the SemanticStore.
    displayName string
    (Updatable) A user-friendly name.
    freeformTags {[key: string]: string}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    lifecycleDetails string
    A message describing the current state in more detail that can provide actionable information.
    refreshSchedule SemanticStoreRefreshSchedule
    (Updatable) Specifies a refresh schedule. Null represents no automated synchronization schedule.
    schemas SemanticStoreSchemas
    (Updatable) Array of database schemas or other database objects to include in enrichment pipeline.
    state string
    The lifecycle state of a SemanticStore.
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The date and time that the SemanticStore was created in the format of an RFC3339 datetime string.
    timeUpdated string
    The date and time that the SemanticStore was updated in the format of an RFC3339 datetime string.
    compartment_id str
    (Updatable) Owning compartment OCID for a SemanticStore.
    data_source SemanticStoreDataSourceArgs
    Defines the data source that the semantic model connects to.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description str
    (Updatable) An optional description of the SemanticStore.
    display_name str
    (Updatable) A user-friendly name.
    freeform_tags Mapping[str, str]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    lifecycle_details str
    A message describing the current state in more detail that can provide actionable information.
    refresh_schedule SemanticStoreRefreshScheduleArgs
    (Updatable) Specifies a refresh schedule. Null represents no automated synchronization schedule.
    schemas SemanticStoreSchemasArgs
    (Updatable) Array of database schemas or other database objects to include in enrichment pipeline.
    state str
    The lifecycle state of a SemanticStore.
    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The date and time that the SemanticStore was created in the format of an RFC3339 datetime string.
    time_updated str
    The date and time that the SemanticStore was updated in the format of an RFC3339 datetime string.
    compartmentId String
    (Updatable) Owning compartment OCID for a SemanticStore.
    dataSource Property Map
    Defines the data source that the semantic model connects to.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) An optional description of the SemanticStore.
    displayName String
    (Updatable) A user-friendly name.
    freeformTags Map<String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    lifecycleDetails String
    A message describing the current state in more detail that can provide actionable information.
    refreshSchedule Property Map
    (Updatable) Specifies a refresh schedule. Null represents no automated synchronization schedule.
    schemas Property Map
    (Updatable) Array of database schemas or other database objects to include in enrichment pipeline.
    state String
    The lifecycle state of a SemanticStore.
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time that the SemanticStore was created in the format of an RFC3339 datetime string.
    timeUpdated String
    The date and time that the SemanticStore was updated in the format of an RFC3339 datetime string.

    Supporting Types

    SemanticStoreDataSource, SemanticStoreDataSourceArgs

    ConnectionType string
    Specifies the type of underlying connection.
    EnrichmentConnectionId string
    The OCID of the Oracle Cloud Infrastructure Database Tools Connection for enrichment.
    QueryingConnectionId string
    The OCID of the Oracle Cloud Infrastructure Database Tools Connection for querying.
    ConnectionType string
    Specifies the type of underlying connection.
    EnrichmentConnectionId string
    The OCID of the Oracle Cloud Infrastructure Database Tools Connection for enrichment.
    QueryingConnectionId string
    The OCID of the Oracle Cloud Infrastructure Database Tools Connection for querying.
    connectionType String
    Specifies the type of underlying connection.
    enrichmentConnectionId String
    The OCID of the Oracle Cloud Infrastructure Database Tools Connection for enrichment.
    queryingConnectionId String
    The OCID of the Oracle Cloud Infrastructure Database Tools Connection for querying.
    connectionType string
    Specifies the type of underlying connection.
    enrichmentConnectionId string
    The OCID of the Oracle Cloud Infrastructure Database Tools Connection for enrichment.
    queryingConnectionId string
    The OCID of the Oracle Cloud Infrastructure Database Tools Connection for querying.
    connection_type str
    Specifies the type of underlying connection.
    enrichment_connection_id str
    The OCID of the Oracle Cloud Infrastructure Database Tools Connection for enrichment.
    querying_connection_id str
    The OCID of the Oracle Cloud Infrastructure Database Tools Connection for querying.
    connectionType String
    Specifies the type of underlying connection.
    enrichmentConnectionId String
    The OCID of the Oracle Cloud Infrastructure Database Tools Connection for enrichment.
    queryingConnectionId String
    The OCID of the Oracle Cloud Infrastructure Database Tools Connection for querying.

    SemanticStoreRefreshSchedule, SemanticStoreRefreshScheduleArgs

    Type string
    (Updatable) Specifies the type of refresh schedule.
    Value string
    (Updatable) Specifies the refresh interval value. The interval must be provided using the ISO 8601 extended format, either as PnW or PnYnMnDTnHnMnS, where 'P' is always required, 'T' precedes any time components less than one day, and each included component is properly suffixed. For example, "P1DT6H" represents a duration of 1 day and 6 hours.
    Type string
    (Updatable) Specifies the type of refresh schedule.
    Value string
    (Updatable) Specifies the refresh interval value. The interval must be provided using the ISO 8601 extended format, either as PnW or PnYnMnDTnHnMnS, where 'P' is always required, 'T' precedes any time components less than one day, and each included component is properly suffixed. For example, "P1DT6H" represents a duration of 1 day and 6 hours.
    type String
    (Updatable) Specifies the type of refresh schedule.
    value String
    (Updatable) Specifies the refresh interval value. The interval must be provided using the ISO 8601 extended format, either as PnW or PnYnMnDTnHnMnS, where 'P' is always required, 'T' precedes any time components less than one day, and each included component is properly suffixed. For example, "P1DT6H" represents a duration of 1 day and 6 hours.
    type string
    (Updatable) Specifies the type of refresh schedule.
    value string
    (Updatable) Specifies the refresh interval value. The interval must be provided using the ISO 8601 extended format, either as PnW or PnYnMnDTnHnMnS, where 'P' is always required, 'T' precedes any time components less than one day, and each included component is properly suffixed. For example, "P1DT6H" represents a duration of 1 day and 6 hours.
    type str
    (Updatable) Specifies the type of refresh schedule.
    value str
    (Updatable) Specifies the refresh interval value. The interval must be provided using the ISO 8601 extended format, either as PnW or PnYnMnDTnHnMnS, where 'P' is always required, 'T' precedes any time components less than one day, and each included component is properly suffixed. For example, "P1DT6H" represents a duration of 1 day and 6 hours.
    type String
    (Updatable) Specifies the type of refresh schedule.
    value String
    (Updatable) Specifies the refresh interval value. The interval must be provided using the ISO 8601 extended format, either as PnW or PnYnMnDTnHnMnS, where 'P' is always required, 'T' precedes any time components less than one day, and each included component is properly suffixed. For example, "P1DT6H" represents a duration of 1 day and 6 hours.

    SemanticStoreSchemas, SemanticStoreSchemasArgs

    ConnectionType string
    (Updatable) Specifies the type of underlying connection.
    Schemas List<SemanticStoreSchemasSchema>
    (Updatable) Array of database schemas to be included in the connection. Each schema must define a name. A simple schema definition includes only the name, for example: { "schemas": [ { "name": "HR" } ] } Only one schema name is allowed now. Additional configuration options may be supported in extended forms later.
    ConnectionType string
    (Updatable) Specifies the type of underlying connection.
    Schemas []SemanticStoreSchemasSchema
    (Updatable) Array of database schemas to be included in the connection. Each schema must define a name. A simple schema definition includes only the name, for example: { "schemas": [ { "name": "HR" } ] } Only one schema name is allowed now. Additional configuration options may be supported in extended forms later.
    connectionType String
    (Updatable) Specifies the type of underlying connection.
    schemas List<SemanticStoreSchemasSchema>
    (Updatable) Array of database schemas to be included in the connection. Each schema must define a name. A simple schema definition includes only the name, for example: { "schemas": [ { "name": "HR" } ] } Only one schema name is allowed now. Additional configuration options may be supported in extended forms later.
    connectionType string
    (Updatable) Specifies the type of underlying connection.
    schemas SemanticStoreSchemasSchema[]
    (Updatable) Array of database schemas to be included in the connection. Each schema must define a name. A simple schema definition includes only the name, for example: { "schemas": [ { "name": "HR" } ] } Only one schema name is allowed now. Additional configuration options may be supported in extended forms later.
    connection_type str
    (Updatable) Specifies the type of underlying connection.
    schemas Sequence[SemanticStoreSchemasSchema]
    (Updatable) Array of database schemas to be included in the connection. Each schema must define a name. A simple schema definition includes only the name, for example: { "schemas": [ { "name": "HR" } ] } Only one schema name is allowed now. Additional configuration options may be supported in extended forms later.
    connectionType String
    (Updatable) Specifies the type of underlying connection.
    schemas List<Property Map>
    (Updatable) Array of database schemas to be included in the connection. Each schema must define a name. A simple schema definition includes only the name, for example: { "schemas": [ { "name": "HR" } ] } Only one schema name is allowed now. Additional configuration options may be supported in extended forms later.

    SemanticStoreSchemasSchema, SemanticStoreSchemasSchemaArgs

    Name string

    (Updatable)

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Name string

    (Updatable)

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    name String

    (Updatable)

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    name string

    (Updatable)

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    name str

    (Updatable)

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    name String

    (Updatable)

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Import

    SemanticStores can be imported using the id, e.g.

    $ pulumi import oci:GenerativeAi/semanticStore:SemanticStore test_semantic_store "id"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Viewing docs for Oracle Cloud Infrastructure v4.10.0
    published on Thursday, May 7, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-oci
      Try Pulumi Cloud free. Your team will thank you.