Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DataIntegration
  5. WorkspaceFolder
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-oci

oci.DataIntegration.WorkspaceFolder

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-oci

    This resource provides the Workspace Folder resource in Oracle Cloud Infrastructure Data Integration service.

    Creates a folder in a project or in another folder, limited to two levels of folders. | Folders are used to organize your design-time resources, such as tasks or data flows.

    Example Usage

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

const testWorkspaceFolder = new oci.dataintegration.WorkspaceFolder("test_workspace_folder", {
    identifier: workspaceFolderIdentifier,
    name: workspaceFolderName,
    registryMetadata: {
        aggregatorKey: workspaceFolderRegistryMetadataAggregatorKey,
        isFavorite: workspaceFolderRegistryMetadataIsFavorite,
        key: workspaceFolderRegistryMetadataKey,
        labels: workspaceFolderRegistryMetadataLabels,
        registryVersion: workspaceFolderRegistryMetadataRegistryVersion,
    },
    workspaceId: testWorkspace.id,
    categoryName: testCategory.name,
    description: workspaceFolderDescription,
    key: workspaceFolderKey,
    modelVersion: workspaceFolderModelVersion,
    objectStatus: workspaceFolderObjectStatus,
});

    import pulumi
import pulumi_oci as oci

test_workspace_folder = oci.data_integration.WorkspaceFolder("test_workspace_folder",
    identifier=workspace_folder_identifier,
    name=workspace_folder_name,
    registry_metadata={
        "aggregator_key": workspace_folder_registry_metadata_aggregator_key,
        "is_favorite": workspace_folder_registry_metadata_is_favorite,
        "key": workspace_folder_registry_metadata_key,
        "labels": workspace_folder_registry_metadata_labels,
        "registry_version": workspace_folder_registry_metadata_registry_version,
    },
    workspace_id=test_workspace["id"],
    category_name=test_category["name"],
    description=workspace_folder_description,
    key=workspace_folder_key,
    model_version=workspace_folder_model_version,
    object_status=workspace_folder_object_status)

    package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/dataintegration"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dataintegration.NewWorkspaceFolder(ctx, "test_workspace_folder", &dataintegration.WorkspaceFolderArgs{
			Identifier: pulumi.Any(workspaceFolderIdentifier),
			Name:       pulumi.Any(workspaceFolderName),
			RegistryMetadata: &dataintegration.WorkspaceFolderRegistryMetadataArgs{
				AggregatorKey:   pulumi.Any(workspaceFolderRegistryMetadataAggregatorKey),
				IsFavorite:      pulumi.Any(workspaceFolderRegistryMetadataIsFavorite),
				Key:             pulumi.Any(workspaceFolderRegistryMetadataKey),
				Labels:          pulumi.Any(workspaceFolderRegistryMetadataLabels),
				RegistryVersion: pulumi.Any(workspaceFolderRegistryMetadataRegistryVersion),
			},
			WorkspaceId:  pulumi.Any(testWorkspace.Id),
			CategoryName: pulumi.Any(testCategory.Name),
			Description:  pulumi.Any(workspaceFolderDescription),
			Key:          pulumi.Any(workspaceFolderKey),
			ModelVersion: pulumi.Any(workspaceFolderModelVersion),
			ObjectStatus: pulumi.Any(workspaceFolderObjectStatus),
		})
		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 testWorkspaceFolder = new Oci.DataIntegration.WorkspaceFolder("test_workspace_folder", new()
    {
        Identifier = workspaceFolderIdentifier,
        Name = workspaceFolderName,
        RegistryMetadata = new Oci.DataIntegration.Inputs.WorkspaceFolderRegistryMetadataArgs
        {
            AggregatorKey = workspaceFolderRegistryMetadataAggregatorKey,
            IsFavorite = workspaceFolderRegistryMetadataIsFavorite,
            Key = workspaceFolderRegistryMetadataKey,
            Labels = workspaceFolderRegistryMetadataLabels,
            RegistryVersion = workspaceFolderRegistryMetadataRegistryVersion,
        },
        WorkspaceId = testWorkspace.Id,
        CategoryName = testCategory.Name,
        Description = workspaceFolderDescription,
        Key = workspaceFolderKey,
        ModelVersion = workspaceFolderModelVersion,
        ObjectStatus = workspaceFolderObjectStatus,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DataIntegration.WorkspaceFolder;
import com.pulumi.oci.DataIntegration.WorkspaceFolderArgs;
import com.pulumi.oci.DataIntegration.inputs.WorkspaceFolderRegistryMetadataArgs;
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 testWorkspaceFolder = new WorkspaceFolder("testWorkspaceFolder", WorkspaceFolderArgs.builder()
            .identifier(workspaceFolderIdentifier)
            .name(workspaceFolderName)
            .registryMetadata(WorkspaceFolderRegistryMetadataArgs.builder()
                .aggregatorKey(workspaceFolderRegistryMetadataAggregatorKey)
                .isFavorite(workspaceFolderRegistryMetadataIsFavorite)
                .key(workspaceFolderRegistryMetadataKey)
                .labels(workspaceFolderRegistryMetadataLabels)
                .registryVersion(workspaceFolderRegistryMetadataRegistryVersion)
                .build())
            .workspaceId(testWorkspace.id())
            .categoryName(testCategory.name())
            .description(workspaceFolderDescription)
            .key(workspaceFolderKey)
            .modelVersion(workspaceFolderModelVersion)
            .objectStatus(workspaceFolderObjectStatus)
            .build());

    }
}

    resources:
  testWorkspaceFolder:
    type: oci:DataIntegration:WorkspaceFolder
    name: test_workspace_folder
    properties:
      identifier: ${workspaceFolderIdentifier}
      name: ${workspaceFolderName}
      registryMetadata:
        aggregatorKey: ${workspaceFolderRegistryMetadataAggregatorKey}
        isFavorite: ${workspaceFolderRegistryMetadataIsFavorite}
        key: ${workspaceFolderRegistryMetadataKey}
        labels: ${workspaceFolderRegistryMetadataLabels}
        registryVersion: ${workspaceFolderRegistryMetadataRegistryVersion}
      workspaceId: ${testWorkspace.id}
      categoryName: ${testCategory.name}
      description: ${workspaceFolderDescription}
      key: ${workspaceFolderKey}
      modelVersion: ${workspaceFolderModelVersion}
      objectStatus: ${workspaceFolderObjectStatus}

    Create WorkspaceFolder Resource

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

    Constructor syntax

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

@overload
def WorkspaceFolder(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    identifier: Optional[str] = None,
                    registry_metadata: Optional[_dataintegration.WorkspaceFolderRegistryMetadataArgs] = None,
                    workspace_id: Optional[str] = None,
                    category_name: Optional[str] = None,
                    description: Optional[str] = None,
                    folder_key: Optional[str] = None,
                    key: Optional[str] = None,
                    model_version: Optional[str] = None,
                    name: Optional[str] = None,
                    object_status: Optional[int] = None)
    func NewWorkspaceFolder(ctx *Context, name string, args WorkspaceFolderArgs, opts ...ResourceOption) (*WorkspaceFolder, error)
    public WorkspaceFolder(string name, WorkspaceFolderArgs args, CustomResourceOptions? opts = null)
    public WorkspaceFolder(String name, WorkspaceFolderArgs args)
public WorkspaceFolder(String name, WorkspaceFolderArgs args, CustomResourceOptions options)

    type: oci:DataIntegration:WorkspaceFolder
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 WorkspaceFolderArgs
    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 WorkspaceFolderArgs
    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 WorkspaceFolderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkspaceFolderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkspaceFolderArgs
    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 workspaceFolderResource = new Oci.DataIntegration.WorkspaceFolder("workspaceFolderResource", new()
{
    Identifier = "string",
    RegistryMetadata = new Oci.DataIntegration.Inputs.WorkspaceFolderRegistryMetadataArgs
    {
        AggregatorKey = "string",
        IsFavorite = false,
        Key = "string",
        Labels = new[]
        {
            "string",
        },
        RegistryVersion = 0,
    },
    WorkspaceId = "string",
    CategoryName = "string",
    Description = "string",
    FolderKey = "string",
    Key = "string",
    ModelVersion = "string",
    Name = "string",
    ObjectStatus = 0,
});

    example, err := DataIntegration.NewWorkspaceFolder(ctx, "workspaceFolderResource", &DataIntegration.WorkspaceFolderArgs{
	Identifier: pulumi.String("string"),
	RegistryMetadata: &dataintegration.WorkspaceFolderRegistryMetadataArgs{
		AggregatorKey: pulumi.String("string"),
		IsFavorite:    pulumi.Bool(false),
		Key:           pulumi.String("string"),
		Labels: pulumi.StringArray{
			pulumi.String("string"),
		},
		RegistryVersion: pulumi.Int(0),
	},
	WorkspaceId:  pulumi.String("string"),
	CategoryName: pulumi.String("string"),
	Description:  pulumi.String("string"),
	FolderKey:    pulumi.String("string"),
	Key:          pulumi.String("string"),
	ModelVersion: pulumi.String("string"),
	Name:         pulumi.String("string"),
	ObjectStatus: pulumi.Int(0),
})

    var workspaceFolderResource = new WorkspaceFolder("workspaceFolderResource", WorkspaceFolderArgs.builder()
    .identifier("string")
    .registryMetadata(WorkspaceFolderRegistryMetadataArgs.builder()
        .aggregatorKey("string")
        .isFavorite(false)
        .key("string")
        .labels("string")
        .registryVersion(0)
        .build())
    .workspaceId("string")
    .categoryName("string")
    .description("string")
    .folderKey("string")
    .key("string")
    .modelVersion("string")
    .name("string")
    .objectStatus(0)
    .build());

    workspace_folder_resource = oci.data_integration.WorkspaceFolder("workspaceFolderResource",
    identifier="string",
    registry_metadata={
        "aggregator_key": "string",
        "is_favorite": False,
        "key": "string",
        "labels": ["string"],
        "registry_version": 0,
    },
    workspace_id="string",
    category_name="string",
    description="string",
    folder_key="string",
    key="string",
    model_version="string",
    name="string",
    object_status=0)

    const workspaceFolderResource = new oci.dataintegration.WorkspaceFolder("workspaceFolderResource", {
    identifier: "string",
    registryMetadata: {
        aggregatorKey: "string",
        isFavorite: false,
        key: "string",
        labels: ["string"],
        registryVersion: 0,
    },
    workspaceId: "string",
    categoryName: "string",
    description: "string",
    folderKey: "string",
    key: "string",
    modelVersion: "string",
    name: "string",
    objectStatus: 0,
});

    type: oci:DataIntegration:WorkspaceFolder
properties:
    categoryName: string
    description: string
    folderKey: string
    identifier: string
    key: string
    modelVersion: string
    name: string
    objectStatus: 0
    registryMetadata:
        aggregatorKey: string
        isFavorite: false
        key: string
        labels:
            - string
        registryVersion: 0
    workspaceId: string

    WorkspaceFolder 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 WorkspaceFolder resource accepts the following input properties:

    Identifier string
    (Updatable) Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified.
    RegistryMetadata WorkspaceFolderRegistryMetadata
    (Updatable) Information about the object and its parent.
    WorkspaceId string

    The workspace ID.

    ** 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

    CategoryName string
    (Updatable) The category name.
    Description string
    (Updatable) A user defined description for the folder.
    FolderKey string
    Key string
    (Updatable) Currently not used on folder creation. Reserved for future.
    ModelVersion string
    (Updatable) The model version of an object.
    Name string
    (Updatable) Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
    ObjectStatus int
    (Updatable) The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
    Identifier string
    (Updatable) Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified.
    RegistryMetadata WorkspaceFolderRegistryMetadataArgs
    (Updatable) Information about the object and its parent.
    WorkspaceId string

    The workspace ID.

    ** 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

    CategoryName string
    (Updatable) The category name.
    Description string
    (Updatable) A user defined description for the folder.
    FolderKey string
    Key string
    (Updatable) Currently not used on folder creation. Reserved for future.
    ModelVersion string
    (Updatable) The model version of an object.
    Name string
    (Updatable) Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
    ObjectStatus int
    (Updatable) The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
    identifier String
    (Updatable) Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified.
    registryMetadata WorkspaceFolderRegistryMetadata
    (Updatable) Information about the object and its parent.
    workspaceId String

    The workspace ID.

    ** 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

    categoryName String
    (Updatable) The category name.
    description String
    (Updatable) A user defined description for the folder.
    folderKey String
    key String
    (Updatable) Currently not used on folder creation. Reserved for future.
    modelVersion String
    (Updatable) The model version of an object.
    name String
    (Updatable) Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
    objectStatus Integer
    (Updatable) The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
    identifier string
    (Updatable) Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified.
    registryMetadata WorkspaceFolderRegistryMetadata
    (Updatable) Information about the object and its parent.
    workspaceId string

    The workspace ID.

    ** 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

    categoryName string
    (Updatable) The category name.
    description string
    (Updatable) A user defined description for the folder.
    folderKey string
    key string
    (Updatable) Currently not used on folder creation. Reserved for future.
    modelVersion string
    (Updatable) The model version of an object.
    name string
    (Updatable) Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
    objectStatus number
    (Updatable) The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
    identifier str
    (Updatable) Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified.
    registry_metadata dataintegration.WorkspaceFolderRegistryMetadataArgs
    (Updatable) Information about the object and its parent.
    workspace_id str

    The workspace ID.

    ** 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

    category_name str
    (Updatable) The category name.
    description str
    (Updatable) A user defined description for the folder.
    folder_key str
    key str
    (Updatable) Currently not used on folder creation. Reserved for future.
    model_version str
    (Updatable) The model version of an object.
    name str
    (Updatable) Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
    object_status int
    (Updatable) The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
    identifier String
    (Updatable) Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified.
    registryMetadata Property Map
    (Updatable) Information about the object and its parent.
    workspaceId String

    The workspace ID.

    ** 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

    categoryName String
    (Updatable) The category name.
    description String
    (Updatable) A user defined description for the folder.
    folderKey String
    key String
    (Updatable) Currently not used on folder creation. Reserved for future.
    modelVersion String
    (Updatable) The model version of an object.
    name String
    (Updatable) Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
    objectStatus Number
    (Updatable) The status of an object that can be set to value 1 for shallow references across objects, other values reserved.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    KeyMap Dictionary<string, string>
    A key map. If provided, the key is replaced with generated key. This structure provides mapping between user provided key and generated key.
    Metadatas List<WorkspaceFolderMetadata>
    A summary type containing information about the object including its key, name and when/who created/updated it.
    ModelType string
    The type of the object.
    ObjectVersion int
    The version of the object that is used to track changes in the object instance.
    ParentReves List<WorkspaceFolderParentRef>
    A reference to the object's parent.
    Id string
    The provider-assigned unique ID for this managed resource.
    KeyMap map[string]string
    A key map. If provided, the key is replaced with generated key. This structure provides mapping between user provided key and generated key.
    Metadatas []WorkspaceFolderMetadata
    A summary type containing information about the object including its key, name and when/who created/updated it.
    ModelType string
    The type of the object.
    ObjectVersion int
    The version of the object that is used to track changes in the object instance.
    ParentReves []WorkspaceFolderParentRef
    A reference to the object's parent.
    id String
    The provider-assigned unique ID for this managed resource.
    keyMap Map<String,String>
    A key map. If provided, the key is replaced with generated key. This structure provides mapping between user provided key and generated key.
    metadatas List<WorkspaceFolderMetadata>
    A summary type containing information about the object including its key, name and when/who created/updated it.
    modelType String
    The type of the object.
    objectVersion Integer
    The version of the object that is used to track changes in the object instance.
    parentReves List<WorkspaceFolderParentRef>
    A reference to the object's parent.
    id string
    The provider-assigned unique ID for this managed resource.
    keyMap {[key: string]: string}
    A key map. If provided, the key is replaced with generated key. This structure provides mapping between user provided key and generated key.
    metadatas WorkspaceFolderMetadata[]
    A summary type containing information about the object including its key, name and when/who created/updated it.
    modelType string
    The type of the object.
    objectVersion number
    The version of the object that is used to track changes in the object instance.
    parentReves WorkspaceFolderParentRef[]
    A reference to the object's parent.
    id str
    The provider-assigned unique ID for this managed resource.
    key_map Mapping[str, str]
    A key map. If provided, the key is replaced with generated key. This structure provides mapping between user provided key and generated key.
    metadatas Sequence[dataintegration.WorkspaceFolderMetadata]
    A summary type containing information about the object including its key, name and when/who created/updated it.
    model_type str
    The type of the object.
    object_version int
    The version of the object that is used to track changes in the object instance.
    parent_reves Sequence[dataintegration.WorkspaceFolderParentRef]
    A reference to the object's parent.
    id String
    The provider-assigned unique ID for this managed resource.
    keyMap Map<String>
    A key map. If provided, the key is replaced with generated key. This structure provides mapping between user provided key and generated key.
    metadatas List<Property Map>
    A summary type containing information about the object including its key, name and when/who created/updated it.
    modelType String
    The type of the object.
    objectVersion Number
    The version of the object that is used to track changes in the object instance.
    parentReves List<Property Map>
    A reference to the object's parent.

    Look up Existing WorkspaceFolder Resource

    Get an existing WorkspaceFolder 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?: WorkspaceFolderState, opts?: CustomResourceOptions): WorkspaceFolder
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        category_name: Optional[str] = None,
        description: Optional[str] = None,
        folder_key: Optional[str] = None,
        identifier: Optional[str] = None,
        key: Optional[str] = None,
        key_map: Optional[Mapping[str, str]] = None,
        metadatas: Optional[Sequence[_dataintegration.WorkspaceFolderMetadataArgs]] = None,
        model_type: Optional[str] = None,
        model_version: Optional[str] = None,
        name: Optional[str] = None,
        object_status: Optional[int] = None,
        object_version: Optional[int] = None,
        parent_reves: Optional[Sequence[_dataintegration.WorkspaceFolderParentRefArgs]] = None,
        registry_metadata: Optional[_dataintegration.WorkspaceFolderRegistryMetadataArgs] = None,
        workspace_id: Optional[str] = None) -> WorkspaceFolder
    func GetWorkspaceFolder(ctx *Context, name string, id IDInput, state *WorkspaceFolderState, opts ...ResourceOption) (*WorkspaceFolder, error)
    public static WorkspaceFolder Get(string name, Input<string> id, WorkspaceFolderState? state, CustomResourceOptions? opts = null)
    public static WorkspaceFolder get(String name, Output<String> id, WorkspaceFolderState state, CustomResourceOptions options)
    resources:  _:    type: oci:DataIntegration:WorkspaceFolder    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:
    CategoryName string
    (Updatable) The category name.
    Description string
    (Updatable) A user defined description for the folder.
    FolderKey string
    Identifier string
    (Updatable) Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified.
    Key string
    (Updatable) Currently not used on folder creation. Reserved for future.
    KeyMap Dictionary<string, string>
    A key map. If provided, the key is replaced with generated key. This structure provides mapping between user provided key and generated key.
    Metadatas List<WorkspaceFolderMetadata>
    A summary type containing information about the object including its key, name and when/who created/updated it.
    ModelType string
    The type of the object.
    ModelVersion string
    (Updatable) The model version of an object.
    Name string
    (Updatable) Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
    ObjectStatus int
    (Updatable) The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
    ObjectVersion int
    The version of the object that is used to track changes in the object instance.
    ParentReves List<WorkspaceFolderParentRef>
    A reference to the object's parent.
    RegistryMetadata WorkspaceFolderRegistryMetadata
    (Updatable) Information about the object and its parent.
    WorkspaceId string

    The workspace ID.

    ** 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

    CategoryName string
    (Updatable) The category name.
    Description string
    (Updatable) A user defined description for the folder.
    FolderKey string
    Identifier string
    (Updatable) Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified.
    Key string
    (Updatable) Currently not used on folder creation. Reserved for future.
    KeyMap map[string]string
    A key map. If provided, the key is replaced with generated key. This structure provides mapping between user provided key and generated key.
    Metadatas []WorkspaceFolderMetadataArgs
    A summary type containing information about the object including its key, name and when/who created/updated it.
    ModelType string
    The type of the object.
    ModelVersion string
    (Updatable) The model version of an object.
    Name string
    (Updatable) Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
    ObjectStatus int
    (Updatable) The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
    ObjectVersion int
    The version of the object that is used to track changes in the object instance.
    ParentReves []WorkspaceFolderParentRefArgs
    A reference to the object's parent.
    RegistryMetadata WorkspaceFolderRegistryMetadataArgs
    (Updatable) Information about the object and its parent.
    WorkspaceId string

    The workspace ID.

    ** 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

    categoryName String
    (Updatable) The category name.
    description String
    (Updatable) A user defined description for the folder.
    folderKey String
    identifier String
    (Updatable) Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified.
    key String
    (Updatable) Currently not used on folder creation. Reserved for future.
    keyMap Map<String,String>
    A key map. If provided, the key is replaced with generated key. This structure provides mapping between user provided key and generated key.
    metadatas List<WorkspaceFolderMetadata>
    A summary type containing information about the object including its key, name and when/who created/updated it.
    modelType String
    The type of the object.
    modelVersion String
    (Updatable) The model version of an object.
    name String
    (Updatable) Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
    objectStatus Integer
    (Updatable) The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
    objectVersion Integer
    The version of the object that is used to track changes in the object instance.
    parentReves List<WorkspaceFolderParentRef>
    A reference to the object's parent.
    registryMetadata WorkspaceFolderRegistryMetadata
    (Updatable) Information about the object and its parent.
    workspaceId String

    The workspace ID.

    ** 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

    categoryName string
    (Updatable) The category name.
    description string
    (Updatable) A user defined description for the folder.
    folderKey string
    identifier string
    (Updatable) Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified.
    key string
    (Updatable) Currently not used on folder creation. Reserved for future.
    keyMap {[key: string]: string}
    A key map. If provided, the key is replaced with generated key. This structure provides mapping between user provided key and generated key.
    metadatas WorkspaceFolderMetadata[]
    A summary type containing information about the object including its key, name and when/who created/updated it.
    modelType string
    The type of the object.
    modelVersion string
    (Updatable) The model version of an object.
    name string
    (Updatable) Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
    objectStatus number
    (Updatable) The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
    objectVersion number
    The version of the object that is used to track changes in the object instance.
    parentReves WorkspaceFolderParentRef[]
    A reference to the object's parent.
    registryMetadata WorkspaceFolderRegistryMetadata
    (Updatable) Information about the object and its parent.
    workspaceId string

    The workspace ID.

    ** 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

    category_name str
    (Updatable) The category name.
    description str
    (Updatable) A user defined description for the folder.
    folder_key str
    identifier str
    (Updatable) Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified.
    key str
    (Updatable) Currently not used on folder creation. Reserved for future.
    key_map Mapping[str, str]
    A key map. If provided, the key is replaced with generated key. This structure provides mapping between user provided key and generated key.
    metadatas Sequence[dataintegration.WorkspaceFolderMetadataArgs]
    A summary type containing information about the object including its key, name and when/who created/updated it.
    model_type str
    The type of the object.
    model_version str
    (Updatable) The model version of an object.
    name str
    (Updatable) Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
    object_status int
    (Updatable) The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
    object_version int
    The version of the object that is used to track changes in the object instance.
    parent_reves Sequence[dataintegration.WorkspaceFolderParentRefArgs]
    A reference to the object's parent.
    registry_metadata dataintegration.WorkspaceFolderRegistryMetadataArgs
    (Updatable) Information about the object and its parent.
    workspace_id str

    The workspace ID.

    ** 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

    categoryName String
    (Updatable) The category name.
    description String
    (Updatable) A user defined description for the folder.
    folderKey String
    identifier String
    (Updatable) Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified.
    key String
    (Updatable) Currently not used on folder creation. Reserved for future.
    keyMap Map<String>
    A key map. If provided, the key is replaced with generated key. This structure provides mapping between user provided key and generated key.
    metadatas List<Property Map>
    A summary type containing information about the object including its key, name and when/who created/updated it.
    modelType String
    The type of the object.
    modelVersion String
    (Updatable) The model version of an object.
    name String
    (Updatable) Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
    objectStatus Number
    (Updatable) The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
    objectVersion Number
    The version of the object that is used to track changes in the object instance.
    parentReves List<Property Map>
    A reference to the object's parent.
    registryMetadata Property Map
    (Updatable) Information about the object and its parent.
    workspaceId String

    The workspace ID.

    ** 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

    Supporting Types

    WorkspaceFolderMetadata, WorkspaceFolderMetadataArgs

    AggregatorKey string
    The owning object key for this object.
    Aggregators List<WorkspaceFolderMetadataAggregator>
    A summary type containing information about the object's aggregator including its type, key, name and description.
    CountStatistics List<WorkspaceFolderMetadataCountStatistic>
    A count statistics.
    CreatedBy string
    The user that created the object.
    CreatedByName string
    The user that created the object.
    IdentifierPath string
    The full path to identify this object.
    InfoFields Dictionary<string, string>
    Information property fields.
    IsFavorite bool
    Specifies whether this object is a favorite or not.
    Labels List<string>
    Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content.
    RegistryVersion int
    The registry version of the object.
    TimeCreated string
    The date and time that the object was created.
    TimeUpdated string
    The date and time that the object was updated.
    UpdatedBy string
    The user that updated the object.
    UpdatedByName string
    The user that updated the object.
    AggregatorKey string
    The owning object key for this object.
    Aggregators []WorkspaceFolderMetadataAggregator
    A summary type containing information about the object's aggregator including its type, key, name and description.
    CountStatistics []WorkspaceFolderMetadataCountStatistic
    A count statistics.
    CreatedBy string
    The user that created the object.
    CreatedByName string
    The user that created the object.
    IdentifierPath string
    The full path to identify this object.
    InfoFields map[string]string
    Information property fields.
    IsFavorite bool
    Specifies whether this object is a favorite or not.
    Labels []string
    Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content.
    RegistryVersion int
    The registry version of the object.
    TimeCreated string
    The date and time that the object was created.
    TimeUpdated string
    The date and time that the object was updated.
    UpdatedBy string
    The user that updated the object.
    UpdatedByName string
    The user that updated the object.
    aggregatorKey String
    The owning object key for this object.
    aggregators List<WorkspaceFolderMetadataAggregator>
    A summary type containing information about the object's aggregator including its type, key, name and description.
    countStatistics List<WorkspaceFolderMetadataCountStatistic>
    A count statistics.
    createdBy String
    The user that created the object.
    createdByName String
    The user that created the object.
    identifierPath String
    The full path to identify this object.
    infoFields Map<String,String>
    Information property fields.
    isFavorite Boolean
    Specifies whether this object is a favorite or not.
    labels List<String>
    Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content.
    registryVersion Integer
    The registry version of the object.
    timeCreated String
    The date and time that the object was created.
    timeUpdated String
    The date and time that the object was updated.
    updatedBy String
    The user that updated the object.
    updatedByName String
    The user that updated the object.
    aggregatorKey string
    The owning object key for this object.
    aggregators WorkspaceFolderMetadataAggregator[]
    A summary type containing information about the object's aggregator including its type, key, name and description.
    countStatistics WorkspaceFolderMetadataCountStatistic[]
    A count statistics.
    createdBy string
    The user that created the object.
    createdByName string
    The user that created the object.
    identifierPath string
    The full path to identify this object.
    infoFields {[key: string]: string}
    Information property fields.
    isFavorite boolean
    Specifies whether this object is a favorite or not.
    labels string[]
    Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content.
    registryVersion number
    The registry version of the object.
    timeCreated string
    The date and time that the object was created.
    timeUpdated string
    The date and time that the object was updated.
    updatedBy string
    The user that updated the object.
    updatedByName string
    The user that updated the object.
    aggregator_key str
    The owning object key for this object.
    aggregators Sequence[dataintegration.WorkspaceFolderMetadataAggregator]
    A summary type containing information about the object's aggregator including its type, key, name and description.
    count_statistics Sequence[dataintegration.WorkspaceFolderMetadataCountStatistic]
    A count statistics.
    created_by str
    The user that created the object.
    created_by_name str
    The user that created the object.
    identifier_path str
    The full path to identify this object.
    info_fields Mapping[str, str]
    Information property fields.
    is_favorite bool
    Specifies whether this object is a favorite or not.
    labels Sequence[str]
    Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content.
    registry_version int
    The registry version of the object.
    time_created str
    The date and time that the object was created.
    time_updated str
    The date and time that the object was updated.
    updated_by str
    The user that updated the object.
    updated_by_name str
    The user that updated the object.
    aggregatorKey String
    The owning object key for this object.
    aggregators List<Property Map>
    A summary type containing information about the object's aggregator including its type, key, name and description.
    countStatistics List<Property Map>
    A count statistics.
    createdBy String
    The user that created the object.
    createdByName String
    The user that created the object.
    identifierPath String
    The full path to identify this object.
    infoFields Map<String>
    Information property fields.
    isFavorite Boolean
    Specifies whether this object is a favorite or not.
    labels List<String>
    Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content.
    registryVersion Number
    The registry version of the object.
    timeCreated String
    The date and time that the object was created.
    timeUpdated String
    The date and time that the object was updated.
    updatedBy String
    The user that updated the object.
    updatedByName String
    The user that updated the object.

    WorkspaceFolderMetadataAggregator, WorkspaceFolderMetadataAggregatorArgs

    Description string
    (Updatable) A user defined description for the folder.
    Identifier string
    (Updatable) Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified.
    Key string
    (Updatable) Currently not used on folder creation. Reserved for future.
    Name string
    (Updatable) Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
    Type string
    The type of the aggregator.
    Description string
    (Updatable) A user defined description for the folder.
    Identifier string
    (Updatable) Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified.
    Key string
    (Updatable) Currently not used on folder creation. Reserved for future.
    Name string
    (Updatable) Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
    Type string
    The type of the aggregator.
    description String
    (Updatable) A user defined description for the folder.
    identifier String
    (Updatable) Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified.
    key String
    (Updatable) Currently not used on folder creation. Reserved for future.
    name String
    (Updatable) Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
    type String
    The type of the aggregator.
    description string
    (Updatable) A user defined description for the folder.
    identifier string
    (Updatable) Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified.
    key string
    (Updatable) Currently not used on folder creation. Reserved for future.
    name string
    (Updatable) Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
    type string
    The type of the aggregator.
    description str
    (Updatable) A user defined description for the folder.
    identifier str
    (Updatable) Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified.
    key str
    (Updatable) Currently not used on folder creation. Reserved for future.
    name str
    (Updatable) Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
    type str
    The type of the aggregator.
    description String
    (Updatable) A user defined description for the folder.
    identifier String
    (Updatable) Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified.
    key String
    (Updatable) Currently not used on folder creation. Reserved for future.
    name String
    (Updatable) Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
    type String
    The type of the aggregator.

    WorkspaceFolderMetadataCountStatistic, WorkspaceFolderMetadataCountStatisticArgs

    WorkspaceFolderMetadataCountStatisticObjectTypeCountList, WorkspaceFolderMetadataCountStatisticObjectTypeCountListArgs

    ObjectCount string
    The value for the count statistic object.
    ObjectType string
    The type of object for the count statistic object.
    ObjectCount string
    The value for the count statistic object.
    ObjectType string
    The type of object for the count statistic object.
    objectCount String
    The value for the count statistic object.
    objectType String
    The type of object for the count statistic object.
    objectCount string
    The value for the count statistic object.
    objectType string
    The type of object for the count statistic object.
    object_count str
    The value for the count statistic object.
    object_type str
    The type of object for the count statistic object.
    objectCount String
    The value for the count statistic object.
    objectType String
    The type of object for the count statistic object.

    WorkspaceFolderParentRef, WorkspaceFolderParentRefArgs

    Parent string
    Key of the parent object.
    RootDocId string
    Key of the root document object.
    Parent string
    Key of the parent object.
    RootDocId string
    Key of the root document object.
    parent String
    Key of the parent object.
    rootDocId String
    Key of the root document object.
    parent string
    Key of the parent object.
    rootDocId string
    Key of the root document object.
    parent str
    Key of the parent object.
    root_doc_id str
    Key of the root document object.
    parent String
    Key of the parent object.
    rootDocId String
    Key of the root document object.

    WorkspaceFolderRegistryMetadata, WorkspaceFolderRegistryMetadataArgs

    AggregatorKey string
    (Updatable) The owning object's key for this object.
    IsFavorite bool
    (Updatable) Specifies whether this object is a favorite or not.
    Key string
    (Updatable) The identifying key for the object.
    Labels List<string>
    (Updatable) Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content.
    RegistryVersion int
    (Updatable) The registry version.
    AggregatorKey string
    (Updatable) The owning object's key for this object.
    IsFavorite bool
    (Updatable) Specifies whether this object is a favorite or not.
    Key string
    (Updatable) The identifying key for the object.
    Labels []string
    (Updatable) Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content.
    RegistryVersion int
    (Updatable) The registry version.
    aggregatorKey String
    (Updatable) The owning object's key for this object.
    isFavorite Boolean
    (Updatable) Specifies whether this object is a favorite or not.
    key String
    (Updatable) The identifying key for the object.
    labels List<String>
    (Updatable) Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content.
    registryVersion Integer
    (Updatable) The registry version.
    aggregatorKey string
    (Updatable) The owning object's key for this object.
    isFavorite boolean
    (Updatable) Specifies whether this object is a favorite or not.
    key string
    (Updatable) The identifying key for the object.
    labels string[]
    (Updatable) Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content.
    registryVersion number
    (Updatable) The registry version.
    aggregator_key str
    (Updatable) The owning object's key for this object.
    is_favorite bool
    (Updatable) Specifies whether this object is a favorite or not.
    key str
    (Updatable) The identifying key for the object.
    labels Sequence[str]
    (Updatable) Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content.
    registry_version int
    (Updatable) The registry version.
    aggregatorKey String
    (Updatable) The owning object's key for this object.
    isFavorite Boolean
    (Updatable) Specifies whether this object is a favorite or not.
    key String
    (Updatable) The identifying key for the object.
    labels List<String>
    (Updatable) Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content.
    registryVersion Number
    (Updatable) The registry version.

    Import

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

    $ pulumi import oci:DataIntegration/workspaceFolder:WorkspaceFolder test_workspace_folder "workspaces/{workspaceId}/folders/{folderKey}"

    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
    Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
    pulumi/pulumi-oci