oci.DataIntegration.WorkspaceFolder
Explore with Pulumi AI
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.
- Registry
Metadata WorkspaceFolder Registry Metadata - (Updatable) Information about the object and its parent.
- Workspace
Id 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 string - (Updatable) The category name.
- Description string
- (Updatable) A user defined description for the folder.
- Folder
Key string - Key string
- (Updatable) Currently not used on folder creation. Reserved for future.
- Model
Version 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.
- 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.
- Registry
Metadata WorkspaceFolder Registry Metadata Args - (Updatable) Information about the object and its parent.
- Workspace
Id 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 string - (Updatable) The category name.
- Description string
- (Updatable) A user defined description for the folder.
- Folder
Key string - Key string
- (Updatable) Currently not used on folder creation. Reserved for future.
- Model
Version 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.
- 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.
- registry
Metadata WorkspaceFolder Registry Metadata - (Updatable) Information about the object and its parent.
- workspace
Id 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 String - (Updatable) The category name.
- description String
- (Updatable) A user defined description for the folder.
- folder
Key String - key String
- (Updatable) Currently not used on folder creation. Reserved for future.
- model
Version 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.
- object
Status 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.
- registry
Metadata WorkspaceFolder Registry Metadata - (Updatable) Information about the object and its parent.
- workspace
Id 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 string - (Updatable) The category name.
- description string
- (Updatable) A user defined description for the folder.
- folder
Key string - key string
- (Updatable) Currently not used on folder creation. Reserved for future.
- model
Version 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.
- object
Status 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.Workspace Folder Registry Metadata Args - (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.
- registry
Metadata Property Map - (Updatable) Information about the object and its parent.
- workspace
Id 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 String - (Updatable) The category name.
- description String
- (Updatable) A user defined description for the folder.
- folder
Key String - key String
- (Updatable) Currently not used on folder creation. Reserved for future.
- model
Version 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.
- object
Status 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.
- Key
Map 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<Workspace
Folder Metadata> - A summary type containing information about the object including its key, name and when/who created/updated it.
- Model
Type string - 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 List<WorkspaceFolder Parent Ref> - A reference to the object's parent.
- Id string
- The provider-assigned unique ID for this managed resource.
- Key
Map 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
[]Workspace
Folder Metadata - A summary type containing information about the object including its key, name and when/who created/updated it.
- Model
Type string - 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 []WorkspaceFolder Parent Ref - A reference to the object's parent.
- id String
- The provider-assigned unique ID for this managed resource.
- key
Map 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<Workspace
Folder Metadata> - A summary type containing information about the object including its key, name and when/who created/updated it.
- model
Type String - The type of the object.
- object
Version Integer - The version of the object that is used to track changes in the object instance.
- parent
Reves List<WorkspaceFolder Parent Ref> - A reference to the object's parent.
- id string
- The provider-assigned unique ID for this managed resource.
- key
Map {[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
Workspace
Folder Metadata[] - A summary type containing information about the object including its key, name and when/who created/updated it.
- model
Type string - The type of the object.
- object
Version number - The version of the object that is used to track changes in the object instance.
- parent
Reves WorkspaceFolder Parent Ref[] - 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.
Workspace Folder Metadata] - 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.Workspace Folder Parent Ref] - A reference to the object's parent.
- id String
- The provider-assigned unique ID for this managed resource.
- key
Map 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.
- model
Type String - The type of the object.
- object
Version Number - The version of the object that is used to track changes in the object instance.
- parent
Reves 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)
Resource lookup is not supported in YAML
- 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.
- Category
Name string - (Updatable) The category name.
- Description string
- (Updatable) A user defined description for the folder.
- Folder
Key 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.
- Key
Map 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<Workspace
Folder Metadata> - A summary type containing information about the object including its key, name and when/who created/updated it.
- Model
Type string - The type of the object.
- Model
Version 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.
- 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 List<WorkspaceFolder Parent Ref> - A reference to the object's parent.
- Registry
Metadata WorkspaceFolder Registry Metadata - (Updatable) Information about the object and its parent.
- Workspace
Id 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 string - (Updatable) The category name.
- Description string
- (Updatable) A user defined description for the folder.
- Folder
Key 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.
- Key
Map 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
[]Workspace
Folder Metadata Args - A summary type containing information about the object including its key, name and when/who created/updated it.
- Model
Type string - The type of the object.
- Model
Version 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.
- 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 []WorkspaceFolder Parent Ref Args - A reference to the object's parent.
- Registry
Metadata WorkspaceFolder Registry Metadata Args - (Updatable) Information about the object and its parent.
- Workspace
Id 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 String - (Updatable) The category name.
- description String
- (Updatable) A user defined description for the folder.
- folder
Key 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.
- key
Map 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<Workspace
Folder Metadata> - A summary type containing information about the object including its key, name and when/who created/updated it.
- model
Type String - The type of the object.
- model
Version 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.
- object
Status Integer - (Updatable) The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
- object
Version Integer - The version of the object that is used to track changes in the object instance.
- parent
Reves List<WorkspaceFolder Parent Ref> - A reference to the object's parent.
- registry
Metadata WorkspaceFolder Registry Metadata - (Updatable) Information about the object and its parent.
- workspace
Id 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 string - (Updatable) The category name.
- description string
- (Updatable) A user defined description for the folder.
- folder
Key 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.
- key
Map {[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
Workspace
Folder Metadata[] - A summary type containing information about the object including its key, name and when/who created/updated it.
- model
Type string - The type of the object.
- model
Version 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.
- object
Status number - (Updatable) The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
- object
Version number - The version of the object that is used to track changes in the object instance.
- parent
Reves WorkspaceFolder Parent Ref[] - A reference to the object's parent.
- registry
Metadata WorkspaceFolder Registry Metadata - (Updatable) Information about the object and its parent.
- workspace
Id 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.
Workspace Folder Metadata Args] - 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.Workspace Folder Parent Ref Args] - A reference to the object's parent.
- registry_
metadata dataintegration.Workspace Folder Registry Metadata Args - (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 String - (Updatable) The category name.
- description String
- (Updatable) A user defined description for the folder.
- folder
Key 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.
- key
Map 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.
- model
Type String - The type of the object.
- model
Version 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.
- object
Status Number - (Updatable) The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
- object
Version Number - The version of the object that is used to track changes in the object instance.
- parent
Reves List<Property Map> - A reference to the object's parent.
- registry
Metadata Property Map - (Updatable) Information about the object and its parent.
- workspace
Id 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
- Aggregator
Key string - The owning object key for this object.
- Aggregators
List<Workspace
Folder Metadata Aggregator> - A summary type containing information about the object's aggregator including its type, key, name and description.
- Count
Statistics List<WorkspaceFolder Metadata Count Statistic> - A count statistics.
- Created
By string - The user that created the object.
- Created
By stringName - The user that created the object.
- Identifier
Path string - The full path to identify this object.
- Info
Fields Dictionary<string, string> - Information property fields.
- Is
Favorite 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.
- Registry
Version int - The registry version of the object.
- Time
Created string - The date and time that the object was created.
- Time
Updated string - The date and time that the object was updated.
- Updated
By string - The user that updated the object.
- Updated
By stringName - The user that updated the object.
- Aggregator
Key string - The owning object key for this object.
- Aggregators
[]Workspace
Folder Metadata Aggregator - A summary type containing information about the object's aggregator including its type, key, name and description.
- Count
Statistics []WorkspaceFolder Metadata Count Statistic - A count statistics.
- Created
By string - The user that created the object.
- Created
By stringName - The user that created the object.
- Identifier
Path string - The full path to identify this object.
- Info
Fields map[string]string - Information property fields.
- Is
Favorite 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.
- Registry
Version int - The registry version of the object.
- Time
Created string - The date and time that the object was created.
- Time
Updated string - The date and time that the object was updated.
- Updated
By string - The user that updated the object.
- Updated
By stringName - The user that updated the object.
- aggregator
Key String - The owning object key for this object.
- aggregators
List<Workspace
Folder Metadata Aggregator> - A summary type containing information about the object's aggregator including its type, key, name and description.
- count
Statistics List<WorkspaceFolder Metadata Count Statistic> - A count statistics.
- created
By String - The user that created the object.
- created
By StringName - The user that created the object.
- identifier
Path String - The full path to identify this object.
- info
Fields Map<String,String> - Information property fields.
- is
Favorite 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.
- registry
Version Integer - The registry version of the object.
- time
Created String - The date and time that the object was created.
- time
Updated String - The date and time that the object was updated.
- updated
By String - The user that updated the object.
- updated
By StringName - The user that updated the object.
- aggregator
Key string - The owning object key for this object.
- aggregators
Workspace
Folder Metadata Aggregator[] - A summary type containing information about the object's aggregator including its type, key, name and description.
- count
Statistics WorkspaceFolder Metadata Count Statistic[] - A count statistics.
- created
By string - The user that created the object.
- created
By stringName - The user that created the object.
- identifier
Path string - The full path to identify this object.
- info
Fields {[key: string]: string} - Information property fields.
- is
Favorite 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.
- registry
Version number - The registry version of the object.
- time
Created string - The date and time that the object was created.
- time
Updated string - The date and time that the object was updated.
- updated
By string - The user that updated the object.
- updated
By stringName - The user that updated the object.
- aggregator_
key str - The owning object key for this object.
- aggregators
Sequence[dataintegration.
Workspace Folder Metadata Aggregator] - A summary type containing information about the object's aggregator including its type, key, name and description.
- count_
statistics Sequence[dataintegration.Workspace Folder Metadata Count Statistic] - A count statistics.
- created_
by str - The user that created the object.
- created_
by_ strname - 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_ strname - The user that updated the object.
- aggregator
Key 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.
- count
Statistics List<Property Map> - A count statistics.
- created
By String - The user that created the object.
- created
By StringName - The user that created the object.
- identifier
Path String - The full path to identify this object.
- info
Fields Map<String> - Information property fields.
- is
Favorite 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.
- registry
Version Number - The registry version of the object.
- time
Created String - The date and time that the object was created.
- time
Updated String - The date and time that the object was updated.
- updated
By String - The user that updated the object.
- updated
By StringName - 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
- Object
Type List<WorkspaceCount Lists Folder Metadata Count Statistic Object Type Count List> - The array of statistics.
- Object
Type []WorkspaceCount Lists Folder Metadata Count Statistic Object Type Count List - The array of statistics.
- object
Type List<WorkspaceCount Lists Folder Metadata Count Statistic Object Type Count List> - The array of statistics.
- object
Type WorkspaceCount Lists Folder Metadata Count Statistic Object Type Count List[] - The array of statistics.
- object
Type List<Property Map>Count Lists - The array of statistics.
WorkspaceFolderMetadataCountStatisticObjectTypeCountList, WorkspaceFolderMetadataCountStatisticObjectTypeCountListArgs
- Object
Count string - The value for the count statistic object.
- Object
Type string - The type of object for the count statistic object.
- Object
Count string - The value for the count statistic object.
- Object
Type string - The type of object for the count statistic object.
- object
Count String - The value for the count statistic object.
- object
Type String - The type of object for the count statistic object.
- object
Count string - The value for the count statistic object.
- object
Type 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.
- object
Count String - The value for the count statistic object.
- object
Type String - The type of object for the count statistic object.
WorkspaceFolderParentRef, WorkspaceFolderParentRefArgs
- parent str
- Key of the parent object.
- root_
doc_ strid - Key of the root document object.
WorkspaceFolderRegistryMetadata, WorkspaceFolderRegistryMetadataArgs
- Aggregator
Key string - (Updatable) The owning object's key for this object.
- Is
Favorite 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.
- Registry
Version int - (Updatable) The registry version.
- Aggregator
Key string - (Updatable) The owning object's key for this object.
- Is
Favorite 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.
- Registry
Version int - (Updatable) The registry version.
- aggregator
Key String - (Updatable) The owning object's key for this object.
- is
Favorite 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.
- registry
Version Integer - (Updatable) The registry version.
- aggregator
Key string - (Updatable) The owning object's key for this object.
- is
Favorite 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.
- registry
Version 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.
- aggregator
Key String - (Updatable) The owning object's key for this object.
- is
Favorite 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.
- registry
Version 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.