Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DataIntegration
  5. Workspace
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

oci.DataIntegration.Workspace

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

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

    Creates a new Data Integration workspace ready for performing data integration tasks. To retrieve the OCID for the new workspace, use the opc-work-request-id returned by this API and call the GetWorkRequest API.

    Example Usage

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

const testWorkspace = new oci.dataintegration.Workspace("test_workspace", {
    compartmentId: compartmentId,
    displayName: workspaceDisplayName,
    definedTags: {
        "Operations.CostCenter": "42",
    },
    description: workspaceDescription,
    dnsServerIp: workspaceDnsServerIp,
    dnsServerZone: workspaceDnsServerZone,
    endpointCompartmentId: testCompartment.id,
    endpointId: testEndpoint.id,
    endpointName: workspaceEndpointName,
    freeformTags: {
        Department: "Finance",
    },
    isPrivateNetworkEnabled: workspaceIsPrivateNetworkEnabled,
    registryCompartmentId: testCompartment.id,
    registryId: testRegistry.id,
    registryName: testRegistry.name,
    subnetId: testSubnet.id,
    vcnId: testVcn.id,
});

    import pulumi
import pulumi_oci as oci

test_workspace = oci.data_integration.Workspace("test_workspace",
    compartment_id=compartment_id,
    display_name=workspace_display_name,
    defined_tags={
        "Operations.CostCenter": "42",
    },
    description=workspace_description,
    dns_server_ip=workspace_dns_server_ip,
    dns_server_zone=workspace_dns_server_zone,
    endpoint_compartment_id=test_compartment["id"],
    endpoint_id=test_endpoint["id"],
    endpoint_name=workspace_endpoint_name,
    freeform_tags={
        "Department": "Finance",
    },
    is_private_network_enabled=workspace_is_private_network_enabled,
    registry_compartment_id=test_compartment["id"],
    registry_id=test_registry["id"],
    registry_name=test_registry["name"],
    subnet_id=test_subnet["id"],
    vcn_id=test_vcn["id"])

    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.NewWorkspace(ctx, "test_workspace", &DataIntegration.WorkspaceArgs{
			CompartmentId: pulumi.Any(compartmentId),
			DisplayName:   pulumi.Any(workspaceDisplayName),
			DefinedTags: pulumi.StringMap{
				"Operations.CostCenter": pulumi.String("42"),
			},
			Description:           pulumi.Any(workspaceDescription),
			DnsServerIp:           pulumi.Any(workspaceDnsServerIp),
			DnsServerZone:         pulumi.Any(workspaceDnsServerZone),
			EndpointCompartmentId: pulumi.Any(testCompartment.Id),
			EndpointId:            pulumi.Any(testEndpoint.Id),
			EndpointName:          pulumi.Any(workspaceEndpointName),
			FreeformTags: pulumi.StringMap{
				"Department": pulumi.String("Finance"),
			},
			IsPrivateNetworkEnabled: pulumi.Any(workspaceIsPrivateNetworkEnabled),
			RegistryCompartmentId:   pulumi.Any(testCompartment.Id),
			RegistryId:              pulumi.Any(testRegistry.Id),
			RegistryName:            pulumi.Any(testRegistry.Name),
			SubnetId:                pulumi.Any(testSubnet.Id),
			VcnId:                   pulumi.Any(testVcn.Id),
		})
		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 testWorkspace = new Oci.DataIntegration.Workspace("test_workspace", new()
    {
        CompartmentId = compartmentId,
        DisplayName = workspaceDisplayName,
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        Description = workspaceDescription,
        DnsServerIp = workspaceDnsServerIp,
        DnsServerZone = workspaceDnsServerZone,
        EndpointCompartmentId = testCompartment.Id,
        EndpointId = testEndpoint.Id,
        EndpointName = workspaceEndpointName,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        IsPrivateNetworkEnabled = workspaceIsPrivateNetworkEnabled,
        RegistryCompartmentId = testCompartment.Id,
        RegistryId = testRegistry.Id,
        RegistryName = testRegistry.Name,
        SubnetId = testSubnet.Id,
        VcnId = testVcn.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DataIntegration.Workspace;
import com.pulumi.oci.DataIntegration.WorkspaceArgs;
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 testWorkspace = new Workspace("testWorkspace", WorkspaceArgs.builder()
            .compartmentId(compartmentId)
            .displayName(workspaceDisplayName)
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .description(workspaceDescription)
            .dnsServerIp(workspaceDnsServerIp)
            .dnsServerZone(workspaceDnsServerZone)
            .endpointCompartmentId(testCompartment.id())
            .endpointId(testEndpoint.id())
            .endpointName(workspaceEndpointName)
            .freeformTags(Map.of("Department", "Finance"))
            .isPrivateNetworkEnabled(workspaceIsPrivateNetworkEnabled)
            .registryCompartmentId(testCompartment.id())
            .registryId(testRegistry.id())
            .registryName(testRegistry.name())
            .subnetId(testSubnet.id())
            .vcnId(testVcn.id())
            .build());

    }
}

    resources:
  testWorkspace:
    type: oci:DataIntegration:Workspace
    name: test_workspace
    properties:
      compartmentId: ${compartmentId}
      displayName: ${workspaceDisplayName}
      definedTags:
        Operations.CostCenter: '42'
      description: ${workspaceDescription}
      dnsServerIp: ${workspaceDnsServerIp}
      dnsServerZone: ${workspaceDnsServerZone}
      endpointCompartmentId: ${testCompartment.id}
      endpointId: ${testEndpoint.id}
      endpointName: ${workspaceEndpointName}
      freeformTags:
        Department: Finance
      isPrivateNetworkEnabled: ${workspaceIsPrivateNetworkEnabled}
      registryCompartmentId: ${testCompartment.id}
      registryId: ${testRegistry.id}
      registryName: ${testRegistry.name}
      subnetId: ${testSubnet.id}
      vcnId: ${testVcn.id}

    Create Workspace Resource

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

    Constructor syntax

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

@overload
def Workspace(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              display_name: Optional[str] = None,
              compartment_id: Optional[str] = None,
              endpoint_name: Optional[str] = None,
              freeform_tags: Optional[Mapping[str, str]] = None,
              dns_server_ip: Optional[str] = None,
              dns_server_zone: Optional[str] = None,
              endpoint_compartment_id: Optional[str] = None,
              endpoint_id: Optional[str] = None,
              defined_tags: Optional[Mapping[str, str]] = None,
              description: Optional[str] = None,
              is_force_operation: Optional[bool] = None,
              is_private_network_enabled: Optional[bool] = None,
              quiesce_timeout: Optional[int] = None,
              registry_compartment_id: Optional[str] = None,
              registry_id: Optional[str] = None,
              registry_name: Optional[str] = None,
              subnet_id: Optional[str] = None,
              vcn_id: Optional[str] = None)
    func NewWorkspace(ctx *Context, name string, args WorkspaceArgs, opts ...ResourceOption) (*Workspace, error)
    public Workspace(string name, WorkspaceArgs args, CustomResourceOptions? opts = null)
    public Workspace(String name, WorkspaceArgs args)
public Workspace(String name, WorkspaceArgs args, CustomResourceOptions options)

    type: oci:DataIntegration:Workspace
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 WorkspaceArgs
    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 WorkspaceArgs
    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 WorkspaceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkspaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkspaceArgs
    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 workspaceResource = new Oci.DataIntegration.Workspace("workspaceResource", new()
{
    DisplayName = "string",
    CompartmentId = "string",
    EndpointName = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    DnsServerIp = "string",
    DnsServerZone = "string",
    EndpointCompartmentId = "string",
    EndpointId = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    Description = "string",
    IsForceOperation = false,
    IsPrivateNetworkEnabled = false,
    QuiesceTimeout = 0,
    RegistryCompartmentId = "string",
    RegistryId = "string",
    RegistryName = "string",
    SubnetId = "string",
    VcnId = "string",
});

    example, err := DataIntegration.NewWorkspace(ctx, "workspaceResource", &DataIntegration.WorkspaceArgs{
	DisplayName:   pulumi.String("string"),
	CompartmentId: pulumi.String("string"),
	EndpointName:  pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DnsServerIp:           pulumi.String("string"),
	DnsServerZone:         pulumi.String("string"),
	EndpointCompartmentId: pulumi.String("string"),
	EndpointId:            pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description:             pulumi.String("string"),
	IsForceOperation:        pulumi.Bool(false),
	IsPrivateNetworkEnabled: pulumi.Bool(false),
	QuiesceTimeout:          pulumi.Int(0),
	RegistryCompartmentId:   pulumi.String("string"),
	RegistryId:              pulumi.String("string"),
	RegistryName:            pulumi.String("string"),
	SubnetId:                pulumi.String("string"),
	VcnId:                   pulumi.String("string"),
})

    var workspaceResource = new Workspace("workspaceResource", WorkspaceArgs.builder()
    .displayName("string")
    .compartmentId("string")
    .endpointName("string")
    .freeformTags(Map.of("string", "string"))
    .dnsServerIp("string")
    .dnsServerZone("string")
    .endpointCompartmentId("string")
    .endpointId("string")
    .definedTags(Map.of("string", "string"))
    .description("string")
    .isForceOperation(false)
    .isPrivateNetworkEnabled(false)
    .quiesceTimeout(0)
    .registryCompartmentId("string")
    .registryId("string")
    .registryName("string")
    .subnetId("string")
    .vcnId("string")
    .build());

    workspace_resource = oci.data_integration.Workspace("workspaceResource",
    display_name="string",
    compartment_id="string",
    endpoint_name="string",
    freeform_tags={
        "string": "string",
    },
    dns_server_ip="string",
    dns_server_zone="string",
    endpoint_compartment_id="string",
    endpoint_id="string",
    defined_tags={
        "string": "string",
    },
    description="string",
    is_force_operation=False,
    is_private_network_enabled=False,
    quiesce_timeout=0,
    registry_compartment_id="string",
    registry_id="string",
    registry_name="string",
    subnet_id="string",
    vcn_id="string")

    const workspaceResource = new oci.dataintegration.Workspace("workspaceResource", {
    displayName: "string",
    compartmentId: "string",
    endpointName: "string",
    freeformTags: {
        string: "string",
    },
    dnsServerIp: "string",
    dnsServerZone: "string",
    endpointCompartmentId: "string",
    endpointId: "string",
    definedTags: {
        string: "string",
    },
    description: "string",
    isForceOperation: false,
    isPrivateNetworkEnabled: false,
    quiesceTimeout: 0,
    registryCompartmentId: "string",
    registryId: "string",
    registryName: "string",
    subnetId: "string",
    vcnId: "string",
});

    type: oci:DataIntegration:Workspace
properties:
    compartmentId: string
    definedTags:
        string: string
    description: string
    displayName: string
    dnsServerIp: string
    dnsServerZone: string
    endpointCompartmentId: string
    endpointId: string
    endpointName: string
    freeformTags:
        string: string
    isForceOperation: false
    isPrivateNetworkEnabled: false
    quiesceTimeout: 0
    registryCompartmentId: string
    registryId: string
    registryName: string
    subnetId: string
    vcnId: string

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

    CompartmentId string
    (Updatable) The OCID of the compartment containing the workspace.
    DisplayName string
    (Updatable) A user-friendly display name for the workspace. Does not have to be unique, and can be modified. Avoid entering confidential information.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) A user defined description for the workspace.
    DnsServerIp string
    The IP of the custom DNS.
    DnsServerZone string
    The DNS zone of the custom DNS to use to resolve names.
    EndpointCompartmentId string
    DCMS PRivate Endpoint Compartment Identifier
    EndpointId string
    DCMS Private Endpoint ID associated with workspace if the pvt networking is enabled
    EndpointName string
    DCMS Private Endpoint Name
    FreeformTags Dictionary<string, string>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}
    IsForceOperation bool
    IsPrivateNetworkEnabled bool
    Specifies whether the private network connection is enabled or disabled.
    QuiesceTimeout int
    RegistryCompartmentId string
    DCMS Data Asset Registry Compartment Identifier
    RegistryId string
    DCMS Data Asset Registry ID to which the workspace is associated
    RegistryName string
    DCMS Data Asset Registry display name
    SubnetId string
    The OCID of the subnet for customer connected databases.
    VcnId string

    The OCID of the VCN the subnet is in.

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

    CompartmentId string
    (Updatable) The OCID of the compartment containing the workspace.
    DisplayName string
    (Updatable) A user-friendly display name for the workspace. Does not have to be unique, and can be modified. Avoid entering confidential information.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) A user defined description for the workspace.
    DnsServerIp string
    The IP of the custom DNS.
    DnsServerZone string
    The DNS zone of the custom DNS to use to resolve names.
    EndpointCompartmentId string
    DCMS PRivate Endpoint Compartment Identifier
    EndpointId string
    DCMS Private Endpoint ID associated with workspace if the pvt networking is enabled
    EndpointName string
    DCMS Private Endpoint Name
    FreeformTags map[string]string
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}
    IsForceOperation bool
    IsPrivateNetworkEnabled bool
    Specifies whether the private network connection is enabled or disabled.
    QuiesceTimeout int
    RegistryCompartmentId string
    DCMS Data Asset Registry Compartment Identifier
    RegistryId string
    DCMS Data Asset Registry ID to which the workspace is associated
    RegistryName string
    DCMS Data Asset Registry display name
    SubnetId string
    The OCID of the subnet for customer connected databases.
    VcnId string

    The OCID of the VCN the subnet is in.

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

    compartmentId String
    (Updatable) The OCID of the compartment containing the workspace.
    displayName String
    (Updatable) A user-friendly display name for the workspace. Does not have to be unique, and can be modified. Avoid entering confidential information.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) A user defined description for the workspace.
    dnsServerIp String
    The IP of the custom DNS.
    dnsServerZone String
    The DNS zone of the custom DNS to use to resolve names.
    endpointCompartmentId String
    DCMS PRivate Endpoint Compartment Identifier
    endpointId String
    DCMS Private Endpoint ID associated with workspace if the pvt networking is enabled
    endpointName String
    DCMS Private Endpoint Name
    freeformTags Map<String,String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}
    isForceOperation Boolean
    isPrivateNetworkEnabled Boolean
    Specifies whether the private network connection is enabled or disabled.
    quiesceTimeout Integer
    registryCompartmentId String
    DCMS Data Asset Registry Compartment Identifier
    registryId String
    DCMS Data Asset Registry ID to which the workspace is associated
    registryName String
    DCMS Data Asset Registry display name
    subnetId String
    The OCID of the subnet for customer connected databases.
    vcnId String

    The OCID of the VCN the subnet is in.

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

    compartmentId string
    (Updatable) The OCID of the compartment containing the workspace.
    displayName string
    (Updatable) A user-friendly display name for the workspace. Does not have to be unique, and can be modified. Avoid entering confidential information.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}
    description string
    (Updatable) A user defined description for the workspace.
    dnsServerIp string
    The IP of the custom DNS.
    dnsServerZone string
    The DNS zone of the custom DNS to use to resolve names.
    endpointCompartmentId string
    DCMS PRivate Endpoint Compartment Identifier
    endpointId string
    DCMS Private Endpoint ID associated with workspace if the pvt networking is enabled
    endpointName string
    DCMS Private Endpoint Name
    freeformTags {[key: string]: string}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}
    isForceOperation boolean
    isPrivateNetworkEnabled boolean
    Specifies whether the private network connection is enabled or disabled.
    quiesceTimeout number
    registryCompartmentId string
    DCMS Data Asset Registry Compartment Identifier
    registryId string
    DCMS Data Asset Registry ID to which the workspace is associated
    registryName string
    DCMS Data Asset Registry display name
    subnetId string
    The OCID of the subnet for customer connected databases.
    vcnId string

    The OCID of the VCN the subnet is in.

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

    compartment_id str
    (Updatable) The OCID of the compartment containing the workspace.
    display_name str
    (Updatable) A user-friendly display name for the workspace. Does not have to be unique, and can be modified. Avoid entering confidential information.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}
    description str
    (Updatable) A user defined description for the workspace.
    dns_server_ip str
    The IP of the custom DNS.
    dns_server_zone str
    The DNS zone of the custom DNS to use to resolve names.
    endpoint_compartment_id str
    DCMS PRivate Endpoint Compartment Identifier
    endpoint_id str
    DCMS Private Endpoint ID associated with workspace if the pvt networking is enabled
    endpoint_name str
    DCMS Private Endpoint Name
    freeform_tags Mapping[str, str]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}
    is_force_operation bool
    is_private_network_enabled bool
    Specifies whether the private network connection is enabled or disabled.
    quiesce_timeout int
    registry_compartment_id str
    DCMS Data Asset Registry Compartment Identifier
    registry_id str
    DCMS Data Asset Registry ID to which the workspace is associated
    registry_name str
    DCMS Data Asset Registry display name
    subnet_id str
    The OCID of the subnet for customer connected databases.
    vcn_id str

    The OCID of the VCN the subnet is in.

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

    compartmentId String
    (Updatable) The OCID of the compartment containing the workspace.
    displayName String
    (Updatable) A user-friendly display name for the workspace. Does not have to be unique, and can be modified. Avoid entering confidential information.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) A user defined description for the workspace.
    dnsServerIp String
    The IP of the custom DNS.
    dnsServerZone String
    The DNS zone of the custom DNS to use to resolve names.
    endpointCompartmentId String
    DCMS PRivate Endpoint Compartment Identifier
    endpointId String
    DCMS Private Endpoint ID associated with workspace if the pvt networking is enabled
    endpointName String
    DCMS Private Endpoint Name
    freeformTags Map<String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}
    isForceOperation Boolean
    isPrivateNetworkEnabled Boolean
    Specifies whether the private network connection is enabled or disabled.
    quiesceTimeout Number
    registryCompartmentId String
    DCMS Data Asset Registry Compartment Identifier
    registryId String
    DCMS Data Asset Registry ID to which the workspace is associated
    registryName String
    DCMS Data Asset Registry display name
    subnetId String
    The OCID of the subnet for customer connected databases.
    vcnId String

    The OCID of the VCN the subnet is in.

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

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    Lifecycle states for workspaces in Data Integration Service CREATING - The resource is being created and may not be usable until the entire metadata is defined UPDATING - The resource is being updated and may not be usable until all changes are commited DELETING - The resource is being deleted and might require deep cleanup of children. ACTIVE - The resource is valid and available for access INACTIVE - The resource might be incomplete in its definition or might have been made unavailable for administrative reasons DELETED - The resource has been deleted and isn't available FAILED - The resource is in a failed state due to validation or other errors STARTING - The resource is being started and may not be usable until becomes ACTIVE again STOPPING - The resource is in the process of Stopping and may not be usable until it Stops or fails STOPPED - The resource is in Stopped state due to stop operation.
    StateMessage string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state.
    TimeCreated string
    The date and time the workspace was created, in the timestamp format defined by RFC3339.
    TimeUpdated string
    The date and time the workspace was updated, in the timestamp format defined by RFC3339.
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    Lifecycle states for workspaces in Data Integration Service CREATING - The resource is being created and may not be usable until the entire metadata is defined UPDATING - The resource is being updated and may not be usable until all changes are commited DELETING - The resource is being deleted and might require deep cleanup of children. ACTIVE - The resource is valid and available for access INACTIVE - The resource might be incomplete in its definition or might have been made unavailable for administrative reasons DELETED - The resource has been deleted and isn't available FAILED - The resource is in a failed state due to validation or other errors STARTING - The resource is being started and may not be usable until becomes ACTIVE again STOPPING - The resource is in the process of Stopping and may not be usable until it Stops or fails STOPPED - The resource is in Stopped state due to stop operation.
    StateMessage string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state.
    TimeCreated string
    The date and time the workspace was created, in the timestamp format defined by RFC3339.
    TimeUpdated string
    The date and time the workspace was updated, in the timestamp format defined by RFC3339.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    Lifecycle states for workspaces in Data Integration Service CREATING - The resource is being created and may not be usable until the entire metadata is defined UPDATING - The resource is being updated and may not be usable until all changes are commited DELETING - The resource is being deleted and might require deep cleanup of children. ACTIVE - The resource is valid and available for access INACTIVE - The resource might be incomplete in its definition or might have been made unavailable for administrative reasons DELETED - The resource has been deleted and isn't available FAILED - The resource is in a failed state due to validation or other errors STARTING - The resource is being started and may not be usable until becomes ACTIVE again STOPPING - The resource is in the process of Stopping and may not be usable until it Stops or fails STOPPED - The resource is in Stopped state due to stop operation.
    stateMessage String
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state.
    timeCreated String
    The date and time the workspace was created, in the timestamp format defined by RFC3339.
    timeUpdated String
    The date and time the workspace was updated, in the timestamp format defined by RFC3339.
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    Lifecycle states for workspaces in Data Integration Service CREATING - The resource is being created and may not be usable until the entire metadata is defined UPDATING - The resource is being updated and may not be usable until all changes are commited DELETING - The resource is being deleted and might require deep cleanup of children. ACTIVE - The resource is valid and available for access INACTIVE - The resource might be incomplete in its definition or might have been made unavailable for administrative reasons DELETED - The resource has been deleted and isn't available FAILED - The resource is in a failed state due to validation or other errors STARTING - The resource is being started and may not be usable until becomes ACTIVE again STOPPING - The resource is in the process of Stopping and may not be usable until it Stops or fails STOPPED - The resource is in Stopped state due to stop operation.
    stateMessage string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state.
    timeCreated string
    The date and time the workspace was created, in the timestamp format defined by RFC3339.
    timeUpdated string
    The date and time the workspace was updated, in the timestamp format defined by RFC3339.
    id str
    The provider-assigned unique ID for this managed resource.
    state str
    Lifecycle states for workspaces in Data Integration Service CREATING - The resource is being created and may not be usable until the entire metadata is defined UPDATING - The resource is being updated and may not be usable until all changes are commited DELETING - The resource is being deleted and might require deep cleanup of children. ACTIVE - The resource is valid and available for access INACTIVE - The resource might be incomplete in its definition or might have been made unavailable for administrative reasons DELETED - The resource has been deleted and isn't available FAILED - The resource is in a failed state due to validation or other errors STARTING - The resource is being started and may not be usable until becomes ACTIVE again STOPPING - The resource is in the process of Stopping and may not be usable until it Stops or fails STOPPED - The resource is in Stopped state due to stop operation.
    state_message str
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state.
    time_created str
    The date and time the workspace was created, in the timestamp format defined by RFC3339.
    time_updated str
    The date and time the workspace was updated, in the timestamp format defined by RFC3339.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    Lifecycle states for workspaces in Data Integration Service CREATING - The resource is being created and may not be usable until the entire metadata is defined UPDATING - The resource is being updated and may not be usable until all changes are commited DELETING - The resource is being deleted and might require deep cleanup of children. ACTIVE - The resource is valid and available for access INACTIVE - The resource might be incomplete in its definition or might have been made unavailable for administrative reasons DELETED - The resource has been deleted and isn't available FAILED - The resource is in a failed state due to validation or other errors STARTING - The resource is being started and may not be usable until becomes ACTIVE again STOPPING - The resource is in the process of Stopping and may not be usable until it Stops or fails STOPPED - The resource is in Stopped state due to stop operation.
    stateMessage String
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state.
    timeCreated String
    The date and time the workspace was created, in the timestamp format defined by RFC3339.
    timeUpdated String
    The date and time the workspace was updated, in the timestamp format defined by RFC3339.

    Look up Existing Workspace Resource

    Get an existing Workspace 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?: WorkspaceState, opts?: CustomResourceOptions): Workspace
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        dns_server_ip: Optional[str] = None,
        dns_server_zone: Optional[str] = None,
        endpoint_compartment_id: Optional[str] = None,
        endpoint_id: Optional[str] = None,
        endpoint_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        is_force_operation: Optional[bool] = None,
        is_private_network_enabled: Optional[bool] = None,
        quiesce_timeout: Optional[int] = None,
        registry_compartment_id: Optional[str] = None,
        registry_id: Optional[str] = None,
        registry_name: Optional[str] = None,
        state: Optional[str] = None,
        state_message: Optional[str] = None,
        subnet_id: Optional[str] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None,
        vcn_id: Optional[str] = None) -> Workspace
    func GetWorkspace(ctx *Context, name string, id IDInput, state *WorkspaceState, opts ...ResourceOption) (*Workspace, error)
    public static Workspace Get(string name, Input<string> id, WorkspaceState? state, CustomResourceOptions? opts = null)
    public static Workspace get(String name, Output<String> id, WorkspaceState 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.
    The following state arguments are supported:
    CompartmentId string
    (Updatable) The OCID of the compartment containing the workspace.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) A user defined description for the workspace.
    DisplayName string
    (Updatable) A user-friendly display name for the workspace. Does not have to be unique, and can be modified. Avoid entering confidential information.
    DnsServerIp string
    The IP of the custom DNS.
    DnsServerZone string
    The DNS zone of the custom DNS to use to resolve names.
    EndpointCompartmentId string
    DCMS PRivate Endpoint Compartment Identifier
    EndpointId string
    DCMS Private Endpoint ID associated with workspace if the pvt networking is enabled
    EndpointName string
    DCMS Private Endpoint Name
    FreeformTags Dictionary<string, string>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}
    IsForceOperation bool
    IsPrivateNetworkEnabled bool
    Specifies whether the private network connection is enabled or disabled.
    QuiesceTimeout int
    RegistryCompartmentId string
    DCMS Data Asset Registry Compartment Identifier
    RegistryId string
    DCMS Data Asset Registry ID to which the workspace is associated
    RegistryName string
    DCMS Data Asset Registry display name
    State string
    Lifecycle states for workspaces in Data Integration Service CREATING - The resource is being created and may not be usable until the entire metadata is defined UPDATING - The resource is being updated and may not be usable until all changes are commited DELETING - The resource is being deleted and might require deep cleanup of children. ACTIVE - The resource is valid and available for access INACTIVE - The resource might be incomplete in its definition or might have been made unavailable for administrative reasons DELETED - The resource has been deleted and isn't available FAILED - The resource is in a failed state due to validation or other errors STARTING - The resource is being started and may not be usable until becomes ACTIVE again STOPPING - The resource is in the process of Stopping and may not be usable until it Stops or fails STOPPED - The resource is in Stopped state due to stop operation.
    StateMessage string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state.
    SubnetId string
    The OCID of the subnet for customer connected databases.
    TimeCreated string
    The date and time the workspace was created, in the timestamp format defined by RFC3339.
    TimeUpdated string
    The date and time the workspace was updated, in the timestamp format defined by RFC3339.
    VcnId string

    The OCID of the VCN the subnet is in.

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

    CompartmentId string
    (Updatable) The OCID of the compartment containing the workspace.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) A user defined description for the workspace.
    DisplayName string
    (Updatable) A user-friendly display name for the workspace. Does not have to be unique, and can be modified. Avoid entering confidential information.
    DnsServerIp string
    The IP of the custom DNS.
    DnsServerZone string
    The DNS zone of the custom DNS to use to resolve names.
    EndpointCompartmentId string
    DCMS PRivate Endpoint Compartment Identifier
    EndpointId string
    DCMS Private Endpoint ID associated with workspace if the pvt networking is enabled
    EndpointName string
    DCMS Private Endpoint Name
    FreeformTags map[string]string
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}
    IsForceOperation bool
    IsPrivateNetworkEnabled bool
    Specifies whether the private network connection is enabled or disabled.
    QuiesceTimeout int
    RegistryCompartmentId string
    DCMS Data Asset Registry Compartment Identifier
    RegistryId string
    DCMS Data Asset Registry ID to which the workspace is associated
    RegistryName string
    DCMS Data Asset Registry display name
    State string
    Lifecycle states for workspaces in Data Integration Service CREATING - The resource is being created and may not be usable until the entire metadata is defined UPDATING - The resource is being updated and may not be usable until all changes are commited DELETING - The resource is being deleted and might require deep cleanup of children. ACTIVE - The resource is valid and available for access INACTIVE - The resource might be incomplete in its definition or might have been made unavailable for administrative reasons DELETED - The resource has been deleted and isn't available FAILED - The resource is in a failed state due to validation or other errors STARTING - The resource is being started and may not be usable until becomes ACTIVE again STOPPING - The resource is in the process of Stopping and may not be usable until it Stops or fails STOPPED - The resource is in Stopped state due to stop operation.
    StateMessage string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state.
    SubnetId string
    The OCID of the subnet for customer connected databases.
    TimeCreated string
    The date and time the workspace was created, in the timestamp format defined by RFC3339.
    TimeUpdated string
    The date and time the workspace was updated, in the timestamp format defined by RFC3339.
    VcnId string

    The OCID of the VCN the subnet is in.

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

    compartmentId String
    (Updatable) The OCID of the compartment containing the workspace.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) A user defined description for the workspace.
    displayName String
    (Updatable) A user-friendly display name for the workspace. Does not have to be unique, and can be modified. Avoid entering confidential information.
    dnsServerIp String
    The IP of the custom DNS.
    dnsServerZone String
    The DNS zone of the custom DNS to use to resolve names.
    endpointCompartmentId String
    DCMS PRivate Endpoint Compartment Identifier
    endpointId String
    DCMS Private Endpoint ID associated with workspace if the pvt networking is enabled
    endpointName String
    DCMS Private Endpoint Name
    freeformTags Map<String,String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}
    isForceOperation Boolean
    isPrivateNetworkEnabled Boolean
    Specifies whether the private network connection is enabled or disabled.
    quiesceTimeout Integer
    registryCompartmentId String
    DCMS Data Asset Registry Compartment Identifier
    registryId String
    DCMS Data Asset Registry ID to which the workspace is associated
    registryName String
    DCMS Data Asset Registry display name
    state String
    Lifecycle states for workspaces in Data Integration Service CREATING - The resource is being created and may not be usable until the entire metadata is defined UPDATING - The resource is being updated and may not be usable until all changes are commited DELETING - The resource is being deleted and might require deep cleanup of children. ACTIVE - The resource is valid and available for access INACTIVE - The resource might be incomplete in its definition or might have been made unavailable for administrative reasons DELETED - The resource has been deleted and isn't available FAILED - The resource is in a failed state due to validation or other errors STARTING - The resource is being started and may not be usable until becomes ACTIVE again STOPPING - The resource is in the process of Stopping and may not be usable until it Stops or fails STOPPED - The resource is in Stopped state due to stop operation.
    stateMessage String
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state.
    subnetId String
    The OCID of the subnet for customer connected databases.
    timeCreated String
    The date and time the workspace was created, in the timestamp format defined by RFC3339.
    timeUpdated String
    The date and time the workspace was updated, in the timestamp format defined by RFC3339.
    vcnId String

    The OCID of the VCN the subnet is in.

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

    compartmentId string
    (Updatable) The OCID of the compartment containing the workspace.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}
    description string
    (Updatable) A user defined description for the workspace.
    displayName string
    (Updatable) A user-friendly display name for the workspace. Does not have to be unique, and can be modified. Avoid entering confidential information.
    dnsServerIp string
    The IP of the custom DNS.
    dnsServerZone string
    The DNS zone of the custom DNS to use to resolve names.
    endpointCompartmentId string
    DCMS PRivate Endpoint Compartment Identifier
    endpointId string
    DCMS Private Endpoint ID associated with workspace if the pvt networking is enabled
    endpointName string
    DCMS Private Endpoint Name
    freeformTags {[key: string]: string}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}
    isForceOperation boolean
    isPrivateNetworkEnabled boolean
    Specifies whether the private network connection is enabled or disabled.
    quiesceTimeout number
    registryCompartmentId string
    DCMS Data Asset Registry Compartment Identifier
    registryId string
    DCMS Data Asset Registry ID to which the workspace is associated
    registryName string
    DCMS Data Asset Registry display name
    state string
    Lifecycle states for workspaces in Data Integration Service CREATING - The resource is being created and may not be usable until the entire metadata is defined UPDATING - The resource is being updated and may not be usable until all changes are commited DELETING - The resource is being deleted and might require deep cleanup of children. ACTIVE - The resource is valid and available for access INACTIVE - The resource might be incomplete in its definition or might have been made unavailable for administrative reasons DELETED - The resource has been deleted and isn't available FAILED - The resource is in a failed state due to validation or other errors STARTING - The resource is being started and may not be usable until becomes ACTIVE again STOPPING - The resource is in the process of Stopping and may not be usable until it Stops or fails STOPPED - The resource is in Stopped state due to stop operation.
    stateMessage string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state.
    subnetId string
    The OCID of the subnet for customer connected databases.
    timeCreated string
    The date and time the workspace was created, in the timestamp format defined by RFC3339.
    timeUpdated string
    The date and time the workspace was updated, in the timestamp format defined by RFC3339.
    vcnId string

    The OCID of the VCN the subnet is in.

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

    compartment_id str
    (Updatable) The OCID of the compartment containing the workspace.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}
    description str
    (Updatable) A user defined description for the workspace.
    display_name str
    (Updatable) A user-friendly display name for the workspace. Does not have to be unique, and can be modified. Avoid entering confidential information.
    dns_server_ip str
    The IP of the custom DNS.
    dns_server_zone str
    The DNS zone of the custom DNS to use to resolve names.
    endpoint_compartment_id str
    DCMS PRivate Endpoint Compartment Identifier
    endpoint_id str
    DCMS Private Endpoint ID associated with workspace if the pvt networking is enabled
    endpoint_name str
    DCMS Private Endpoint Name
    freeform_tags Mapping[str, str]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}
    is_force_operation bool
    is_private_network_enabled bool
    Specifies whether the private network connection is enabled or disabled.
    quiesce_timeout int
    registry_compartment_id str
    DCMS Data Asset Registry Compartment Identifier
    registry_id str
    DCMS Data Asset Registry ID to which the workspace is associated
    registry_name str
    DCMS Data Asset Registry display name
    state str
    Lifecycle states for workspaces in Data Integration Service CREATING - The resource is being created and may not be usable until the entire metadata is defined UPDATING - The resource is being updated and may not be usable until all changes are commited DELETING - The resource is being deleted and might require deep cleanup of children. ACTIVE - The resource is valid and available for access INACTIVE - The resource might be incomplete in its definition or might have been made unavailable for administrative reasons DELETED - The resource has been deleted and isn't available FAILED - The resource is in a failed state due to validation or other errors STARTING - The resource is being started and may not be usable until becomes ACTIVE again STOPPING - The resource is in the process of Stopping and may not be usable until it Stops or fails STOPPED - The resource is in Stopped state due to stop operation.
    state_message str
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state.
    subnet_id str
    The OCID of the subnet for customer connected databases.
    time_created str
    The date and time the workspace was created, in the timestamp format defined by RFC3339.
    time_updated str
    The date and time the workspace was updated, in the timestamp format defined by RFC3339.
    vcn_id str

    The OCID of the VCN the subnet is in.

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

    compartmentId String
    (Updatable) The OCID of the compartment containing the workspace.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) A user defined description for the workspace.
    displayName String
    (Updatable) A user-friendly display name for the workspace. Does not have to be unique, and can be modified. Avoid entering confidential information.
    dnsServerIp String
    The IP of the custom DNS.
    dnsServerZone String
    The DNS zone of the custom DNS to use to resolve names.
    endpointCompartmentId String
    DCMS PRivate Endpoint Compartment Identifier
    endpointId String
    DCMS Private Endpoint ID associated with workspace if the pvt networking is enabled
    endpointName String
    DCMS Private Endpoint Name
    freeformTags Map<String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}
    isForceOperation Boolean
    isPrivateNetworkEnabled Boolean
    Specifies whether the private network connection is enabled or disabled.
    quiesceTimeout Number
    registryCompartmentId String
    DCMS Data Asset Registry Compartment Identifier
    registryId String
    DCMS Data Asset Registry ID to which the workspace is associated
    registryName String
    DCMS Data Asset Registry display name
    state String
    Lifecycle states for workspaces in Data Integration Service CREATING - The resource is being created and may not be usable until the entire metadata is defined UPDATING - The resource is being updated and may not be usable until all changes are commited DELETING - The resource is being deleted and might require deep cleanup of children. ACTIVE - The resource is valid and available for access INACTIVE - The resource might be incomplete in its definition or might have been made unavailable for administrative reasons DELETED - The resource has been deleted and isn't available FAILED - The resource is in a failed state due to validation or other errors STARTING - The resource is being started and may not be usable until becomes ACTIVE again STOPPING - The resource is in the process of Stopping and may not be usable until it Stops or fails STOPPED - The resource is in Stopped state due to stop operation.
    stateMessage String
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state.
    subnetId String
    The OCID of the subnet for customer connected databases.
    timeCreated String
    The date and time the workspace was created, in the timestamp format defined by RFC3339.
    timeUpdated String
    The date and time the workspace was updated, in the timestamp format defined by RFC3339.
    vcnId String

    The OCID of the VCN the subnet is in.

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

    Import

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

    $ pulumi import oci:DataIntegration/workspace:Workspace test_workspace "id"

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

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-oci