Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. SchematicsWorkspace
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.SchematicsWorkspace

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Create, read, update, and delete operations of Schematics workspace. Other Schematics operations such as plan, apply, destroy that are available through Schematics console are currently not supported. For more information, about IBM Cloud Schematics workspace, refer to setting up workspaces.

    Example Usage

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

const schematicsWorkspace = new ibm.SchematicsWorkspace("schematicsWorkspace", {
    description: "<workspace_description>",
    location: "us-east",
    resourceGroup: "default",
    templateType: "terraform_v0.13.5",
});

    import pulumi
import pulumi_ibm as ibm

schematics_workspace = ibm.SchematicsWorkspace("schematicsWorkspace",
    description="<workspace_description>",
    location="us-east",
    resource_group="default",
    template_type="terraform_v0.13.5")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewSchematicsWorkspace(ctx, "schematicsWorkspace", &ibm.SchematicsWorkspaceArgs{
			Description:   pulumi.String("<workspace_description>"),
			Location:      pulumi.String("us-east"),
			ResourceGroup: pulumi.String("default"),
			TemplateType:  pulumi.String("terraform_v0.13.5"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var schematicsWorkspace = new Ibm.SchematicsWorkspace("schematicsWorkspace", new()
    {
        Description = "<workspace_description>",
        Location = "us-east",
        ResourceGroup = "default",
        TemplateType = "terraform_v0.13.5",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.SchematicsWorkspace;
import com.pulumi.ibm.SchematicsWorkspaceArgs;
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 schematicsWorkspace = new SchematicsWorkspace("schematicsWorkspace", SchematicsWorkspaceArgs.builder()
            .description("<workspace_description>")
            .location("us-east")
            .resourceGroup("default")
            .templateType("terraform_v0.13.5")
            .build());

    }
}

    resources:
  schematicsWorkspace:
    type: ibm:SchematicsWorkspace
    properties:
      description: <workspace_description>
      location: us-east
      resourceGroup: default
      templateType: terraform_v0.13.5

    Create SchematicsWorkspace Resource

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

    Constructor syntax

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

@overload
def SchematicsWorkspace(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        template_type: Optional[str] = None,
                        tags: Optional[Sequence[str]] = None,
                        template_git_repo_url: Optional[str] = None,
                        frozen: Optional[bool] = None,
                        frozen_at: Optional[str] = None,
                        frozen_by: Optional[str] = None,
                        location: Optional[str] = None,
                        locked: Optional[bool] = None,
                        locked_by: Optional[str] = None,
                        locked_time: Optional[str] = None,
                        name: Optional[str] = None,
                        resource_group: Optional[str] = None,
                        schematics_workspace_id: Optional[str] = None,
                        shared_data: Optional[SchematicsWorkspaceSharedDataArgs] = None,
                        applied_shareddata_ids: Optional[Sequence[str]] = None,
                        description: Optional[str] = None,
                        template_env_settings: Optional[Sequence[Mapping[str, str]]] = None,
                        template_init_state_file: Optional[str] = None,
                        template_git_has_uploadedgitrepotar: Optional[bool] = None,
                        template_git_release: Optional[str] = None,
                        template_git_repo_sha_value: Optional[str] = None,
                        template_git_branch: Optional[str] = None,
                        template_git_url: Optional[str] = None,
                        template_git_folder: Optional[str] = None,
                        template_inputs: Optional[Sequence[SchematicsWorkspaceTemplateInputArgs]] = None,
                        template_ref: Optional[str] = None,
                        catalog_ref: Optional[SchematicsWorkspaceCatalogRefArgs] = None,
                        template_uninstall_script_name: Optional[str] = None,
                        template_values: Optional[str] = None,
                        template_values_metadatas: Optional[Sequence[SchematicsWorkspaceTemplateValuesMetadataArgs]] = None,
                        x_github_token: Optional[str] = None)
    func NewSchematicsWorkspace(ctx *Context, name string, args SchematicsWorkspaceArgs, opts ...ResourceOption) (*SchematicsWorkspace, error)
    public SchematicsWorkspace(string name, SchematicsWorkspaceArgs args, CustomResourceOptions? opts = null)
    public SchematicsWorkspace(String name, SchematicsWorkspaceArgs args)
public SchematicsWorkspace(String name, SchematicsWorkspaceArgs args, CustomResourceOptions options)

    type: ibm:SchematicsWorkspace
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 SchematicsWorkspaceArgs
    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 SchematicsWorkspaceArgs
    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 SchematicsWorkspaceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SchematicsWorkspaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SchematicsWorkspaceArgs
    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 schematicsWorkspaceResource = new Ibm.SchematicsWorkspace("schematicsWorkspaceResource", new()
{
    TemplateType = "string",
    Tags = new[]
    {
        "string",
    },
    TemplateGitRepoUrl = "string",
    Frozen = false,
    FrozenAt = "string",
    FrozenBy = "string",
    Location = "string",
    Locked = false,
    LockedBy = "string",
    LockedTime = "string",
    Name = "string",
    ResourceGroup = "string",
    SchematicsWorkspaceId = "string",
    SharedData = new Ibm.Inputs.SchematicsWorkspaceSharedDataArgs
    {
        ClusterCreatedOn = "string",
        ClusterId = "string",
        ClusterName = "string",
        ClusterType = "string",
        EntitlementKeys = new[]
        {
            
            {
                { "string", "string" },
            },
        },
        Namespace = "string",
        Region = "string",
        ResourceGroupId = "string",
        WorkerCount = 0,
        WorkerMachineType = "string",
    },
    AppliedShareddataIds = new[]
    {
        "string",
    },
    Description = "string",
    TemplateEnvSettings = new[]
    {
        
        {
            { "string", "string" },
        },
    },
    TemplateInitStateFile = "string",
    TemplateGitHasUploadedgitrepotar = false,
    TemplateGitRelease = "string",
    TemplateGitRepoShaValue = "string",
    TemplateGitBranch = "string",
    TemplateGitUrl = "string",
    TemplateGitFolder = "string",
    TemplateInputs = new[]
    {
        new Ibm.Inputs.SchematicsWorkspaceTemplateInputArgs
        {
            Name = "string",
            Type = "string",
            Value = "string",
            Description = "string",
            Secure = false,
            UseDefault = false,
        },
    },
    TemplateRef = "string",
    CatalogRef = new Ibm.Inputs.SchematicsWorkspaceCatalogRefArgs
    {
        DryRun = false,
        ItemIconUrl = "string",
        ItemId = "string",
        ItemName = "string",
        ItemReadmeUrl = "string",
        ItemUrl = "string",
        LaunchUrl = "string",
        OfferingVersion = "string",
        OwningAccount = "string",
    },
    TemplateUninstallScriptName = "string",
    TemplateValues = "string",
    TemplateValuesMetadatas = new[]
    {
        new Ibm.Inputs.SchematicsWorkspaceTemplateValuesMetadataArgs
        {
            Aliases = new[]
            {
                "string",
            },
            CloudDataType = "string",
            Default = "string",
            Description = "string",
            GroupBy = "string",
            Hidden = false,
            Immutable = false,
            LinkStatus = "string",
            Matches = "string",
            MaxLength = 0,
            MaxValue = 0,
            MinLength = 0,
            MinValue = 0,
            Name = "string",
            Options = new[]
            {
                "string",
            },
            Position = 0,
            Required = false,
            Secure = false,
            Source = "string",
            Type = "string",
        },
    },
    XGithubToken = "string",
});

    example, err := ibm.NewSchematicsWorkspace(ctx, "schematicsWorkspaceResource", &ibm.SchematicsWorkspaceArgs{
	TemplateType: pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	TemplateGitRepoUrl:    pulumi.String("string"),
	Frozen:                pulumi.Bool(false),
	FrozenAt:              pulumi.String("string"),
	FrozenBy:              pulumi.String("string"),
	Location:              pulumi.String("string"),
	Locked:                pulumi.Bool(false),
	LockedBy:              pulumi.String("string"),
	LockedTime:            pulumi.String("string"),
	Name:                  pulumi.String("string"),
	ResourceGroup:         pulumi.String("string"),
	SchematicsWorkspaceId: pulumi.String("string"),
	SharedData: &ibm.SchematicsWorkspaceSharedDataArgs{
		ClusterCreatedOn: pulumi.String("string"),
		ClusterId:        pulumi.String("string"),
		ClusterName:      pulumi.String("string"),
		ClusterType:      pulumi.String("string"),
		EntitlementKeys: pulumi.StringMapArray{
			pulumi.StringMap{
				"string": pulumi.String("string"),
			},
		},
		Namespace:         pulumi.String("string"),
		Region:            pulumi.String("string"),
		ResourceGroupId:   pulumi.String("string"),
		WorkerCount:       pulumi.Float64(0),
		WorkerMachineType: pulumi.String("string"),
	},
	AppliedShareddataIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	TemplateEnvSettings: pulumi.StringMapArray{
		pulumi.StringMap{
			"string": pulumi.String("string"),
		},
	},
	TemplateInitStateFile:            pulumi.String("string"),
	TemplateGitHasUploadedgitrepotar: pulumi.Bool(false),
	TemplateGitRelease:               pulumi.String("string"),
	TemplateGitRepoShaValue:          pulumi.String("string"),
	TemplateGitBranch:                pulumi.String("string"),
	TemplateGitUrl:                   pulumi.String("string"),
	TemplateGitFolder:                pulumi.String("string"),
	TemplateInputs: ibm.SchematicsWorkspaceTemplateInputArray{
		&ibm.SchematicsWorkspaceTemplateInputArgs{
			Name:        pulumi.String("string"),
			Type:        pulumi.String("string"),
			Value:       pulumi.String("string"),
			Description: pulumi.String("string"),
			Secure:      pulumi.Bool(false),
			UseDefault:  pulumi.Bool(false),
		},
	},
	TemplateRef: pulumi.String("string"),
	CatalogRef: &ibm.SchematicsWorkspaceCatalogRefArgs{
		DryRun:          pulumi.Bool(false),
		ItemIconUrl:     pulumi.String("string"),
		ItemId:          pulumi.String("string"),
		ItemName:        pulumi.String("string"),
		ItemReadmeUrl:   pulumi.String("string"),
		ItemUrl:         pulumi.String("string"),
		LaunchUrl:       pulumi.String("string"),
		OfferingVersion: pulumi.String("string"),
		OwningAccount:   pulumi.String("string"),
	},
	TemplateUninstallScriptName: pulumi.String("string"),
	TemplateValues:              pulumi.String("string"),
	TemplateValuesMetadatas: ibm.SchematicsWorkspaceTemplateValuesMetadataArray{
		&ibm.SchematicsWorkspaceTemplateValuesMetadataArgs{
			Aliases: pulumi.StringArray{
				pulumi.String("string"),
			},
			CloudDataType: pulumi.String("string"),
			Default:       pulumi.String("string"),
			Description:   pulumi.String("string"),
			GroupBy:       pulumi.String("string"),
			Hidden:        pulumi.Bool(false),
			Immutable:     pulumi.Bool(false),
			LinkStatus:    pulumi.String("string"),
			Matches:       pulumi.String("string"),
			MaxLength:     pulumi.Float64(0),
			MaxValue:      pulumi.Float64(0),
			MinLength:     pulumi.Float64(0),
			MinValue:      pulumi.Float64(0),
			Name:          pulumi.String("string"),
			Options: pulumi.StringArray{
				pulumi.String("string"),
			},
			Position: pulumi.Float64(0),
			Required: pulumi.Bool(false),
			Secure:   pulumi.Bool(false),
			Source:   pulumi.String("string"),
			Type:     pulumi.String("string"),
		},
	},
	XGithubToken: pulumi.String("string"),
})

    var schematicsWorkspaceResource = new SchematicsWorkspace("schematicsWorkspaceResource", SchematicsWorkspaceArgs.builder()
    .templateType("string")
    .tags("string")
    .templateGitRepoUrl("string")
    .frozen(false)
    .frozenAt("string")
    .frozenBy("string")
    .location("string")
    .locked(false)
    .lockedBy("string")
    .lockedTime("string")
    .name("string")
    .resourceGroup("string")
    .schematicsWorkspaceId("string")
    .sharedData(SchematicsWorkspaceSharedDataArgs.builder()
        .clusterCreatedOn("string")
        .clusterId("string")
        .clusterName("string")
        .clusterType("string")
        .entitlementKeys(Map.of("string", "string"))
        .namespace("string")
        .region("string")
        .resourceGroupId("string")
        .workerCount(0)
        .workerMachineType("string")
        .build())
    .appliedShareddataIds("string")
    .description("string")
    .templateEnvSettings(Map.of("string", "string"))
    .templateInitStateFile("string")
    .templateGitHasUploadedgitrepotar(false)
    .templateGitRelease("string")
    .templateGitRepoShaValue("string")
    .templateGitBranch("string")
    .templateGitUrl("string")
    .templateGitFolder("string")
    .templateInputs(SchematicsWorkspaceTemplateInputArgs.builder()
        .name("string")
        .type("string")
        .value("string")
        .description("string")
        .secure(false)
        .useDefault(false)
        .build())
    .templateRef("string")
    .catalogRef(SchematicsWorkspaceCatalogRefArgs.builder()
        .dryRun(false)
        .itemIconUrl("string")
        .itemId("string")
        .itemName("string")
        .itemReadmeUrl("string")
        .itemUrl("string")
        .launchUrl("string")
        .offeringVersion("string")
        .owningAccount("string")
        .build())
    .templateUninstallScriptName("string")
    .templateValues("string")
    .templateValuesMetadatas(SchematicsWorkspaceTemplateValuesMetadataArgs.builder()
        .aliases("string")
        .cloudDataType("string")
        .default_("string")
        .description("string")
        .groupBy("string")
        .hidden(false)
        .immutable(false)
        .linkStatus("string")
        .matches("string")
        .maxLength(0)
        .maxValue(0)
        .minLength(0)
        .minValue(0)
        .name("string")
        .options("string")
        .position(0)
        .required(false)
        .secure(false)
        .source("string")
        .type("string")
        .build())
    .xGithubToken("string")
    .build());

    schematics_workspace_resource = ibm.SchematicsWorkspace("schematicsWorkspaceResource",
    template_type="string",
    tags=["string"],
    template_git_repo_url="string",
    frozen=False,
    frozen_at="string",
    frozen_by="string",
    location="string",
    locked=False,
    locked_by="string",
    locked_time="string",
    name="string",
    resource_group="string",
    schematics_workspace_id="string",
    shared_data={
        "cluster_created_on": "string",
        "cluster_id": "string",
        "cluster_name": "string",
        "cluster_type": "string",
        "entitlement_keys": [{
            "string": "string",
        }],
        "namespace": "string",
        "region": "string",
        "resource_group_id": "string",
        "worker_count": 0,
        "worker_machine_type": "string",
    },
    applied_shareddata_ids=["string"],
    description="string",
    template_env_settings=[{
        "string": "string",
    }],
    template_init_state_file="string",
    template_git_has_uploadedgitrepotar=False,
    template_git_release="string",
    template_git_repo_sha_value="string",
    template_git_branch="string",
    template_git_url="string",
    template_git_folder="string",
    template_inputs=[{
        "name": "string",
        "type": "string",
        "value": "string",
        "description": "string",
        "secure": False,
        "use_default": False,
    }],
    template_ref="string",
    catalog_ref={
        "dry_run": False,
        "item_icon_url": "string",
        "item_id": "string",
        "item_name": "string",
        "item_readme_url": "string",
        "item_url": "string",
        "launch_url": "string",
        "offering_version": "string",
        "owning_account": "string",
    },
    template_uninstall_script_name="string",
    template_values="string",
    template_values_metadatas=[{
        "aliases": ["string"],
        "cloud_data_type": "string",
        "default": "string",
        "description": "string",
        "group_by": "string",
        "hidden": False,
        "immutable": False,
        "link_status": "string",
        "matches": "string",
        "max_length": 0,
        "max_value": 0,
        "min_length": 0,
        "min_value": 0,
        "name": "string",
        "options": ["string"],
        "position": 0,
        "required": False,
        "secure": False,
        "source": "string",
        "type": "string",
    }],
    x_github_token="string")

    const schematicsWorkspaceResource = new ibm.SchematicsWorkspace("schematicsWorkspaceResource", {
    templateType: "string",
    tags: ["string"],
    templateGitRepoUrl: "string",
    frozen: false,
    frozenAt: "string",
    frozenBy: "string",
    location: "string",
    locked: false,
    lockedBy: "string",
    lockedTime: "string",
    name: "string",
    resourceGroup: "string",
    schematicsWorkspaceId: "string",
    sharedData: {
        clusterCreatedOn: "string",
        clusterId: "string",
        clusterName: "string",
        clusterType: "string",
        entitlementKeys: [{
            string: "string",
        }],
        namespace: "string",
        region: "string",
        resourceGroupId: "string",
        workerCount: 0,
        workerMachineType: "string",
    },
    appliedShareddataIds: ["string"],
    description: "string",
    templateEnvSettings: [{
        string: "string",
    }],
    templateInitStateFile: "string",
    templateGitHasUploadedgitrepotar: false,
    templateGitRelease: "string",
    templateGitRepoShaValue: "string",
    templateGitBranch: "string",
    templateGitUrl: "string",
    templateGitFolder: "string",
    templateInputs: [{
        name: "string",
        type: "string",
        value: "string",
        description: "string",
        secure: false,
        useDefault: false,
    }],
    templateRef: "string",
    catalogRef: {
        dryRun: false,
        itemIconUrl: "string",
        itemId: "string",
        itemName: "string",
        itemReadmeUrl: "string",
        itemUrl: "string",
        launchUrl: "string",
        offeringVersion: "string",
        owningAccount: "string",
    },
    templateUninstallScriptName: "string",
    templateValues: "string",
    templateValuesMetadatas: [{
        aliases: ["string"],
        cloudDataType: "string",
        "default": "string",
        description: "string",
        groupBy: "string",
        hidden: false,
        immutable: false,
        linkStatus: "string",
        matches: "string",
        maxLength: 0,
        maxValue: 0,
        minLength: 0,
        minValue: 0,
        name: "string",
        options: ["string"],
        position: 0,
        required: false,
        secure: false,
        source: "string",
        type: "string",
    }],
    xGithubToken: "string",
});

    type: ibm:SchematicsWorkspace
properties:
    appliedShareddataIds:
        - string
    catalogRef:
        dryRun: false
        itemIconUrl: string
        itemId: string
        itemName: string
        itemReadmeUrl: string
        itemUrl: string
        launchUrl: string
        offeringVersion: string
        owningAccount: string
    description: string
    frozen: false
    frozenAt: string
    frozenBy: string
    location: string
    locked: false
    lockedBy: string
    lockedTime: string
    name: string
    resourceGroup: string
    schematicsWorkspaceId: string
    sharedData:
        clusterCreatedOn: string
        clusterId: string
        clusterName: string
        clusterType: string
        entitlementKeys:
            - string: string
        namespace: string
        region: string
        resourceGroupId: string
        workerCount: 0
        workerMachineType: string
    tags:
        - string
    templateEnvSettings:
        - string: string
    templateGitBranch: string
    templateGitFolder: string
    templateGitHasUploadedgitrepotar: false
    templateGitRelease: string
    templateGitRepoShaValue: string
    templateGitRepoUrl: string
    templateGitUrl: string
    templateInitStateFile: string
    templateInputs:
        - description: string
          name: string
          secure: false
          type: string
          useDefault: false
          value: string
    templateRef: string
    templateType: string
    templateUninstallScriptName: string
    templateValues: string
    templateValuesMetadatas:
        - aliases:
            - string
          cloudDataType: string
          default: string
          description: string
          groupBy: string
          hidden: false
          immutable: false
          linkStatus: string
          matches: string
          maxLength: 0
          maxValue: 0
          minLength: 0
          minValue: 0
          name: string
          options:
            - string
          position: 0
          required: false
          secure: false
          source: string
          type: string
    xGithubToken: string

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

    TemplateType string
    AppliedShareddataIds List<string>
    List of applied shared dataset ID.
    CatalogRef SchematicsWorkspaceCatalogRef
    Information about the software template that you chose from the IBM Cloud catalog. This information is returned for IBM Cloud catalog offerings only. MaxItems:1. Nested scheme for catalog_ref:
    Description string
    The description of the workspace.
    Frozen bool
    If set to true, the workspace is frozen and changes to the workspace are disabled.
    FrozenAt string
    The timestamp when the workspace was frozen.
    FrozenBy string
    The user ID that froze the workspace.
    Location string
    The location where you want to create your Schematics workspace and run the Schematics jobs. The location that you enter must match the API endpoint that you use. For example, if you use the Frankfurt API endpoint, you must specify eu-de as your location. If you use an API endpoint for a geography and you do not specify a location, Schematics determines the location based on availability.
    Locked bool
    If set to true, the workspace is locked and disabled for changes.
    LockedBy string
    The user ID that initiated a resource-related job, such as applying or destroying resources, that locked the workspace.
    LockedTime string
    The timestamp when the workspace was locked.
    Name string
    ResourceGroup string
    The ID of the resource group where you want to provision the workspace.
    SchematicsWorkspaceId string
    SharedData SchematicsWorkspaceSharedData
    Tags List<string>
    A list of tags that are associated with the workspace.
    TemplateEnvSettings List<ImmutableDictionary<string, string>>
    TemplateGitBranch string
    The repository branch.
    TemplateGitFolder string
    TemplateGitHasUploadedgitrepotar bool
    Has uploaded git repo tar
    TemplateGitRelease string
    The repository release.
    TemplateGitRepoShaValue string
    The repository SHA value.
    TemplateGitRepoUrl string
    The repository URL.
    TemplateGitUrl string
    The source URL.
    TemplateInitStateFile string
    TemplateInputs List<SchematicsWorkspaceTemplateInput>
    VariablesRequest -. Nested scheme for variablestore:
    TemplateRef string
    Workspace template ref.
    TemplateUninstallScriptName string
    Uninstall script name.
    TemplateValues string
    TemplateValuesMetadatas List<SchematicsWorkspaceTemplateValuesMetadata>
    List of values metadata. Nested scheme for template_values_metadata:
    XGithubToken string
    TemplateType string
    AppliedShareddataIds []string
    List of applied shared dataset ID.
    CatalogRef SchematicsWorkspaceCatalogRefArgs
    Information about the software template that you chose from the IBM Cloud catalog. This information is returned for IBM Cloud catalog offerings only. MaxItems:1. Nested scheme for catalog_ref:
    Description string
    The description of the workspace.
    Frozen bool
    If set to true, the workspace is frozen and changes to the workspace are disabled.
    FrozenAt string
    The timestamp when the workspace was frozen.
    FrozenBy string
    The user ID that froze the workspace.
    Location string
    The location where you want to create your Schematics workspace and run the Schematics jobs. The location that you enter must match the API endpoint that you use. For example, if you use the Frankfurt API endpoint, you must specify eu-de as your location. If you use an API endpoint for a geography and you do not specify a location, Schematics determines the location based on availability.
    Locked bool
    If set to true, the workspace is locked and disabled for changes.
    LockedBy string
    The user ID that initiated a resource-related job, such as applying or destroying resources, that locked the workspace.
    LockedTime string
    The timestamp when the workspace was locked.
    Name string
    ResourceGroup string
    The ID of the resource group where you want to provision the workspace.
    SchematicsWorkspaceId string
    SharedData SchematicsWorkspaceSharedDataArgs
    Tags []string
    A list of tags that are associated with the workspace.
    TemplateEnvSettings []map[string]string
    TemplateGitBranch string
    The repository branch.
    TemplateGitFolder string
    TemplateGitHasUploadedgitrepotar bool
    Has uploaded git repo tar
    TemplateGitRelease string
    The repository release.
    TemplateGitRepoShaValue string
    The repository SHA value.
    TemplateGitRepoUrl string
    The repository URL.
    TemplateGitUrl string
    The source URL.
    TemplateInitStateFile string
    TemplateInputs []SchematicsWorkspaceTemplateInputArgs
    VariablesRequest -. Nested scheme for variablestore:
    TemplateRef string
    Workspace template ref.
    TemplateUninstallScriptName string
    Uninstall script name.
    TemplateValues string
    TemplateValuesMetadatas []SchematicsWorkspaceTemplateValuesMetadataArgs
    List of values metadata. Nested scheme for template_values_metadata:
    XGithubToken string
    templateType String
    appliedShareddataIds List<String>
    List of applied shared dataset ID.
    catalogRef SchematicsWorkspaceCatalogRef
    Information about the software template that you chose from the IBM Cloud catalog. This information is returned for IBM Cloud catalog offerings only. MaxItems:1. Nested scheme for catalog_ref:
    description String
    The description of the workspace.
    frozen Boolean
    If set to true, the workspace is frozen and changes to the workspace are disabled.
    frozenAt String
    The timestamp when the workspace was frozen.
    frozenBy String
    The user ID that froze the workspace.
    location String
    The location where you want to create your Schematics workspace and run the Schematics jobs. The location that you enter must match the API endpoint that you use. For example, if you use the Frankfurt API endpoint, you must specify eu-de as your location. If you use an API endpoint for a geography and you do not specify a location, Schematics determines the location based on availability.
    locked Boolean
    If set to true, the workspace is locked and disabled for changes.
    lockedBy String
    The user ID that initiated a resource-related job, such as applying or destroying resources, that locked the workspace.
    lockedTime String
    The timestamp when the workspace was locked.
    name String
    resourceGroup String
    The ID of the resource group where you want to provision the workspace.
    schematicsWorkspaceId String
    sharedData SchematicsWorkspaceSharedData
    tags List<String>
    A list of tags that are associated with the workspace.
    templateEnvSettings List<Map<String,String>>
    templateGitBranch String
    The repository branch.
    templateGitFolder String
    templateGitHasUploadedgitrepotar Boolean
    Has uploaded git repo tar
    templateGitRelease String
    The repository release.
    templateGitRepoShaValue String
    The repository SHA value.
    templateGitRepoUrl String
    The repository URL.
    templateGitUrl String
    The source URL.
    templateInitStateFile String
    templateInputs List<SchematicsWorkspaceTemplateInput>
    VariablesRequest -. Nested scheme for variablestore:
    templateRef String
    Workspace template ref.
    templateUninstallScriptName String
    Uninstall script name.
    templateValues String
    templateValuesMetadatas List<SchematicsWorkspaceTemplateValuesMetadata>
    List of values metadata. Nested scheme for template_values_metadata:
    xGithubToken String
    templateType string
    appliedShareddataIds string[]
    List of applied shared dataset ID.
    catalogRef SchematicsWorkspaceCatalogRef
    Information about the software template that you chose from the IBM Cloud catalog. This information is returned for IBM Cloud catalog offerings only. MaxItems:1. Nested scheme for catalog_ref:
    description string
    The description of the workspace.
    frozen boolean
    If set to true, the workspace is frozen and changes to the workspace are disabled.
    frozenAt string
    The timestamp when the workspace was frozen.
    frozenBy string
    The user ID that froze the workspace.
    location string
    The location where you want to create your Schematics workspace and run the Schematics jobs. The location that you enter must match the API endpoint that you use. For example, if you use the Frankfurt API endpoint, you must specify eu-de as your location. If you use an API endpoint for a geography and you do not specify a location, Schematics determines the location based on availability.
    locked boolean
    If set to true, the workspace is locked and disabled for changes.
    lockedBy string
    The user ID that initiated a resource-related job, such as applying or destroying resources, that locked the workspace.
    lockedTime string
    The timestamp when the workspace was locked.
    name string
    resourceGroup string
    The ID of the resource group where you want to provision the workspace.
    schematicsWorkspaceId string
    sharedData SchematicsWorkspaceSharedData
    tags string[]
    A list of tags that are associated with the workspace.
    templateEnvSettings {[key: string]: string}[]
    templateGitBranch string
    The repository branch.
    templateGitFolder string
    templateGitHasUploadedgitrepotar boolean
    Has uploaded git repo tar
    templateGitRelease string
    The repository release.
    templateGitRepoShaValue string
    The repository SHA value.
    templateGitRepoUrl string
    The repository URL.
    templateGitUrl string
    The source URL.
    templateInitStateFile string
    templateInputs SchematicsWorkspaceTemplateInput[]
    VariablesRequest -. Nested scheme for variablestore:
    templateRef string
    Workspace template ref.
    templateUninstallScriptName string
    Uninstall script name.
    templateValues string
    templateValuesMetadatas SchematicsWorkspaceTemplateValuesMetadata[]
    List of values metadata. Nested scheme for template_values_metadata:
    xGithubToken string
    template_type str
    applied_shareddata_ids Sequence[str]
    List of applied shared dataset ID.
    catalog_ref SchematicsWorkspaceCatalogRefArgs
    Information about the software template that you chose from the IBM Cloud catalog. This information is returned for IBM Cloud catalog offerings only. MaxItems:1. Nested scheme for catalog_ref:
    description str
    The description of the workspace.
    frozen bool
    If set to true, the workspace is frozen and changes to the workspace are disabled.
    frozen_at str
    The timestamp when the workspace was frozen.
    frozen_by str
    The user ID that froze the workspace.
    location str
    The location where you want to create your Schematics workspace and run the Schematics jobs. The location that you enter must match the API endpoint that you use. For example, if you use the Frankfurt API endpoint, you must specify eu-de as your location. If you use an API endpoint for a geography and you do not specify a location, Schematics determines the location based on availability.
    locked bool
    If set to true, the workspace is locked and disabled for changes.
    locked_by str
    The user ID that initiated a resource-related job, such as applying or destroying resources, that locked the workspace.
    locked_time str
    The timestamp when the workspace was locked.
    name str
    resource_group str
    The ID of the resource group where you want to provision the workspace.
    schematics_workspace_id str
    shared_data SchematicsWorkspaceSharedDataArgs
    tags Sequence[str]
    A list of tags that are associated with the workspace.
    template_env_settings Sequence[Mapping[str, str]]
    template_git_branch str
    The repository branch.
    template_git_folder str
    template_git_has_uploadedgitrepotar bool
    Has uploaded git repo tar
    template_git_release str
    The repository release.
    template_git_repo_sha_value str
    The repository SHA value.
    template_git_repo_url str
    The repository URL.
    template_git_url str
    The source URL.
    template_init_state_file str
    template_inputs Sequence[SchematicsWorkspaceTemplateInputArgs]
    VariablesRequest -. Nested scheme for variablestore:
    template_ref str
    Workspace template ref.
    template_uninstall_script_name str
    Uninstall script name.
    template_values str
    template_values_metadatas Sequence[SchematicsWorkspaceTemplateValuesMetadataArgs]
    List of values metadata. Nested scheme for template_values_metadata:
    x_github_token str
    templateType String
    appliedShareddataIds List<String>
    List of applied shared dataset ID.
    catalogRef Property Map
    Information about the software template that you chose from the IBM Cloud catalog. This information is returned for IBM Cloud catalog offerings only. MaxItems:1. Nested scheme for catalog_ref:
    description String
    The description of the workspace.
    frozen Boolean
    If set to true, the workspace is frozen and changes to the workspace are disabled.
    frozenAt String
    The timestamp when the workspace was frozen.
    frozenBy String
    The user ID that froze the workspace.
    location String
    The location where you want to create your Schematics workspace and run the Schematics jobs. The location that you enter must match the API endpoint that you use. For example, if you use the Frankfurt API endpoint, you must specify eu-de as your location. If you use an API endpoint for a geography and you do not specify a location, Schematics determines the location based on availability.
    locked Boolean
    If set to true, the workspace is locked and disabled for changes.
    lockedBy String
    The user ID that initiated a resource-related job, such as applying or destroying resources, that locked the workspace.
    lockedTime String
    The timestamp when the workspace was locked.
    name String
    resourceGroup String
    The ID of the resource group where you want to provision the workspace.
    schematicsWorkspaceId String
    sharedData Property Map
    tags List<String>
    A list of tags that are associated with the workspace.
    templateEnvSettings List<Map<String>>
    templateGitBranch String
    The repository branch.
    templateGitFolder String
    templateGitHasUploadedgitrepotar Boolean
    Has uploaded git repo tar
    templateGitRelease String
    The repository release.
    templateGitRepoShaValue String
    The repository SHA value.
    templateGitRepoUrl String
    The repository URL.
    templateGitUrl String
    The source URL.
    templateInitStateFile String
    templateInputs List<Property Map>
    VariablesRequest -. Nested scheme for variablestore:
    templateRef String
    Workspace template ref.
    templateUninstallScriptName String
    Uninstall script name.
    templateValues String
    templateValuesMetadatas List<Property Map>
    List of values metadata. Nested scheme for template_values_metadata:
    xGithubToken String

    Outputs

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

    CreatedAt string
    (String) The timestamp when the workspace was created.
    CreatedBy string
    (String) The user ID that created the workspace.
    Crn string
    (Optional, String) The workspace CRN.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastHealthCheckAt string
    (String) The timestamp when the last health check was performed by Schematics.
    RuntimeDatas List<SchematicsWorkspaceRuntimeData>
    (Optional, List) Information about the provisioning engine, state file, and runtime logs. Nested scheme for runtime_data:
    Status string
    StatusCode string
    (String) The success or error code that was returned for the last plan, apply, or destroy job that ran against your workspace.
    StatusMsg string
    (String) The success or error message that was returned for the last plan, apply, or destroy job that ran against your workspace.
    UpdatedAt string
    (String) The timestamp when the workspace was last updated.
    UpdatedBy string
    (String) The user ID that updated the workspace.
    CreatedAt string
    (String) The timestamp when the workspace was created.
    CreatedBy string
    (String) The user ID that created the workspace.
    Crn string
    (Optional, String) The workspace CRN.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastHealthCheckAt string
    (String) The timestamp when the last health check was performed by Schematics.
    RuntimeDatas []SchematicsWorkspaceRuntimeData
    (Optional, List) Information about the provisioning engine, state file, and runtime logs. Nested scheme for runtime_data:
    Status string
    StatusCode string
    (String) The success or error code that was returned for the last plan, apply, or destroy job that ran against your workspace.
    StatusMsg string
    (String) The success or error message that was returned for the last plan, apply, or destroy job that ran against your workspace.
    UpdatedAt string
    (String) The timestamp when the workspace was last updated.
    UpdatedBy string
    (String) The user ID that updated the workspace.
    createdAt String
    (String) The timestamp when the workspace was created.
    createdBy String
    (String) The user ID that created the workspace.
    crn String
    (Optional, String) The workspace CRN.
    id String
    The provider-assigned unique ID for this managed resource.
    lastHealthCheckAt String
    (String) The timestamp when the last health check was performed by Schematics.
    runtimeDatas List<SchematicsWorkspaceRuntimeData>
    (Optional, List) Information about the provisioning engine, state file, and runtime logs. Nested scheme for runtime_data:
    status String
    statusCode String
    (String) The success or error code that was returned for the last plan, apply, or destroy job that ran against your workspace.
    statusMsg String
    (String) The success or error message that was returned for the last plan, apply, or destroy job that ran against your workspace.
    updatedAt String
    (String) The timestamp when the workspace was last updated.
    updatedBy String
    (String) The user ID that updated the workspace.
    createdAt string
    (String) The timestamp when the workspace was created.
    createdBy string
    (String) The user ID that created the workspace.
    crn string
    (Optional, String) The workspace CRN.
    id string
    The provider-assigned unique ID for this managed resource.
    lastHealthCheckAt string
    (String) The timestamp when the last health check was performed by Schematics.
    runtimeDatas SchematicsWorkspaceRuntimeData[]
    (Optional, List) Information about the provisioning engine, state file, and runtime logs. Nested scheme for runtime_data:
    status string
    statusCode string
    (String) The success or error code that was returned for the last plan, apply, or destroy job that ran against your workspace.
    statusMsg string
    (String) The success or error message that was returned for the last plan, apply, or destroy job that ran against your workspace.
    updatedAt string
    (String) The timestamp when the workspace was last updated.
    updatedBy string
    (String) The user ID that updated the workspace.
    created_at str
    (String) The timestamp when the workspace was created.
    created_by str
    (String) The user ID that created the workspace.
    crn str
    (Optional, String) The workspace CRN.
    id str
    The provider-assigned unique ID for this managed resource.
    last_health_check_at str
    (String) The timestamp when the last health check was performed by Schematics.
    runtime_datas Sequence[SchematicsWorkspaceRuntimeData]
    (Optional, List) Information about the provisioning engine, state file, and runtime logs. Nested scheme for runtime_data:
    status str
    status_code str
    (String) The success or error code that was returned for the last plan, apply, or destroy job that ran against your workspace.
    status_msg str
    (String) The success or error message that was returned for the last plan, apply, or destroy job that ran against your workspace.
    updated_at str
    (String) The timestamp when the workspace was last updated.
    updated_by str
    (String) The user ID that updated the workspace.
    createdAt String
    (String) The timestamp when the workspace was created.
    createdBy String
    (String) The user ID that created the workspace.
    crn String
    (Optional, String) The workspace CRN.
    id String
    The provider-assigned unique ID for this managed resource.
    lastHealthCheckAt String
    (String) The timestamp when the last health check was performed by Schematics.
    runtimeDatas List<Property Map>
    (Optional, List) Information about the provisioning engine, state file, and runtime logs. Nested scheme for runtime_data:
    status String
    statusCode String
    (String) The success or error code that was returned for the last plan, apply, or destroy job that ran against your workspace.
    statusMsg String
    (String) The success or error message that was returned for the last plan, apply, or destroy job that ran against your workspace.
    updatedAt String
    (String) The timestamp when the workspace was last updated.
    updatedBy String
    (String) The user ID that updated the workspace.

    Look up Existing SchematicsWorkspace Resource

    Get an existing SchematicsWorkspace 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?: SchematicsWorkspaceState, opts?: CustomResourceOptions): SchematicsWorkspace
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        applied_shareddata_ids: Optional[Sequence[str]] = None,
        catalog_ref: Optional[SchematicsWorkspaceCatalogRefArgs] = None,
        created_at: Optional[str] = None,
        created_by: Optional[str] = None,
        crn: Optional[str] = None,
        description: Optional[str] = None,
        frozen: Optional[bool] = None,
        frozen_at: Optional[str] = None,
        frozen_by: Optional[str] = None,
        last_health_check_at: Optional[str] = None,
        location: Optional[str] = None,
        locked: Optional[bool] = None,
        locked_by: Optional[str] = None,
        locked_time: Optional[str] = None,
        name: Optional[str] = None,
        resource_group: Optional[str] = None,
        runtime_datas: Optional[Sequence[SchematicsWorkspaceRuntimeDataArgs]] = None,
        schematics_workspace_id: Optional[str] = None,
        shared_data: Optional[SchematicsWorkspaceSharedDataArgs] = None,
        status: Optional[str] = None,
        status_code: Optional[str] = None,
        status_msg: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        template_env_settings: Optional[Sequence[Mapping[str, str]]] = None,
        template_git_branch: Optional[str] = None,
        template_git_folder: Optional[str] = None,
        template_git_has_uploadedgitrepotar: Optional[bool] = None,
        template_git_release: Optional[str] = None,
        template_git_repo_sha_value: Optional[str] = None,
        template_git_repo_url: Optional[str] = None,
        template_git_url: Optional[str] = None,
        template_init_state_file: Optional[str] = None,
        template_inputs: Optional[Sequence[SchematicsWorkspaceTemplateInputArgs]] = None,
        template_ref: Optional[str] = None,
        template_type: Optional[str] = None,
        template_uninstall_script_name: Optional[str] = None,
        template_values: Optional[str] = None,
        template_values_metadatas: Optional[Sequence[SchematicsWorkspaceTemplateValuesMetadataArgs]] = None,
        updated_at: Optional[str] = None,
        updated_by: Optional[str] = None,
        x_github_token: Optional[str] = None) -> SchematicsWorkspace
    func GetSchematicsWorkspace(ctx *Context, name string, id IDInput, state *SchematicsWorkspaceState, opts ...ResourceOption) (*SchematicsWorkspace, error)
    public static SchematicsWorkspace Get(string name, Input<string> id, SchematicsWorkspaceState? state, CustomResourceOptions? opts = null)
    public static SchematicsWorkspace get(String name, Output<String> id, SchematicsWorkspaceState state, CustomResourceOptions options)
    resources:  _:    type: ibm:SchematicsWorkspace    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AppliedShareddataIds List<string>
    List of applied shared dataset ID.
    CatalogRef SchematicsWorkspaceCatalogRef
    Information about the software template that you chose from the IBM Cloud catalog. This information is returned for IBM Cloud catalog offerings only. MaxItems:1. Nested scheme for catalog_ref:
    CreatedAt string
    (String) The timestamp when the workspace was created.
    CreatedBy string
    (String) The user ID that created the workspace.
    Crn string
    (Optional, String) The workspace CRN.
    Description string
    The description of the workspace.
    Frozen bool
    If set to true, the workspace is frozen and changes to the workspace are disabled.
    FrozenAt string
    The timestamp when the workspace was frozen.
    FrozenBy string
    The user ID that froze the workspace.
    LastHealthCheckAt string
    (String) The timestamp when the last health check was performed by Schematics.
    Location string
    The location where you want to create your Schematics workspace and run the Schematics jobs. The location that you enter must match the API endpoint that you use. For example, if you use the Frankfurt API endpoint, you must specify eu-de as your location. If you use an API endpoint for a geography and you do not specify a location, Schematics determines the location based on availability.
    Locked bool
    If set to true, the workspace is locked and disabled for changes.
    LockedBy string
    The user ID that initiated a resource-related job, such as applying or destroying resources, that locked the workspace.
    LockedTime string
    The timestamp when the workspace was locked.
    Name string
    ResourceGroup string
    The ID of the resource group where you want to provision the workspace.
    RuntimeDatas List<SchematicsWorkspaceRuntimeData>
    (Optional, List) Information about the provisioning engine, state file, and runtime logs. Nested scheme for runtime_data:
    SchematicsWorkspaceId string
    SharedData SchematicsWorkspaceSharedData
    Status string
    StatusCode string
    (String) The success or error code that was returned for the last plan, apply, or destroy job that ran against your workspace.
    StatusMsg string
    (String) The success or error message that was returned for the last plan, apply, or destroy job that ran against your workspace.
    Tags List<string>
    A list of tags that are associated with the workspace.
    TemplateEnvSettings List<ImmutableDictionary<string, string>>
    TemplateGitBranch string
    The repository branch.
    TemplateGitFolder string
    TemplateGitHasUploadedgitrepotar bool
    Has uploaded git repo tar
    TemplateGitRelease string
    The repository release.
    TemplateGitRepoShaValue string
    The repository SHA value.
    TemplateGitRepoUrl string
    The repository URL.
    TemplateGitUrl string
    The source URL.
    TemplateInitStateFile string
    TemplateInputs List<SchematicsWorkspaceTemplateInput>
    VariablesRequest -. Nested scheme for variablestore:
    TemplateRef string
    Workspace template ref.
    TemplateType string
    TemplateUninstallScriptName string
    Uninstall script name.
    TemplateValues string
    TemplateValuesMetadatas List<SchematicsWorkspaceTemplateValuesMetadata>
    List of values metadata. Nested scheme for template_values_metadata:
    UpdatedAt string
    (String) The timestamp when the workspace was last updated.
    UpdatedBy string
    (String) The user ID that updated the workspace.
    XGithubToken string
    AppliedShareddataIds []string
    List of applied shared dataset ID.
    CatalogRef SchematicsWorkspaceCatalogRefArgs
    Information about the software template that you chose from the IBM Cloud catalog. This information is returned for IBM Cloud catalog offerings only. MaxItems:1. Nested scheme for catalog_ref:
    CreatedAt string
    (String) The timestamp when the workspace was created.
    CreatedBy string
    (String) The user ID that created the workspace.
    Crn string
    (Optional, String) The workspace CRN.
    Description string
    The description of the workspace.
    Frozen bool
    If set to true, the workspace is frozen and changes to the workspace are disabled.
    FrozenAt string
    The timestamp when the workspace was frozen.
    FrozenBy string
    The user ID that froze the workspace.
    LastHealthCheckAt string
    (String) The timestamp when the last health check was performed by Schematics.
    Location string
    The location where you want to create your Schematics workspace and run the Schematics jobs. The location that you enter must match the API endpoint that you use. For example, if you use the Frankfurt API endpoint, you must specify eu-de as your location. If you use an API endpoint for a geography and you do not specify a location, Schematics determines the location based on availability.
    Locked bool
    If set to true, the workspace is locked and disabled for changes.
    LockedBy string
    The user ID that initiated a resource-related job, such as applying or destroying resources, that locked the workspace.
    LockedTime string
    The timestamp when the workspace was locked.
    Name string
    ResourceGroup string
    The ID of the resource group where you want to provision the workspace.
    RuntimeDatas []SchematicsWorkspaceRuntimeDataArgs
    (Optional, List) Information about the provisioning engine, state file, and runtime logs. Nested scheme for runtime_data:
    SchematicsWorkspaceId string
    SharedData SchematicsWorkspaceSharedDataArgs
    Status string
    StatusCode string
    (String) The success or error code that was returned for the last plan, apply, or destroy job that ran against your workspace.
    StatusMsg string
    (String) The success or error message that was returned for the last plan, apply, or destroy job that ran against your workspace.
    Tags []string
    A list of tags that are associated with the workspace.
    TemplateEnvSettings []map[string]string
    TemplateGitBranch string
    The repository branch.
    TemplateGitFolder string
    TemplateGitHasUploadedgitrepotar bool
    Has uploaded git repo tar
    TemplateGitRelease string
    The repository release.
    TemplateGitRepoShaValue string
    The repository SHA value.
    TemplateGitRepoUrl string
    The repository URL.
    TemplateGitUrl string
    The source URL.
    TemplateInitStateFile string
    TemplateInputs []SchematicsWorkspaceTemplateInputArgs
    VariablesRequest -. Nested scheme for variablestore:
    TemplateRef string
    Workspace template ref.
    TemplateType string
    TemplateUninstallScriptName string
    Uninstall script name.
    TemplateValues string
    TemplateValuesMetadatas []SchematicsWorkspaceTemplateValuesMetadataArgs
    List of values metadata. Nested scheme for template_values_metadata:
    UpdatedAt string
    (String) The timestamp when the workspace was last updated.
    UpdatedBy string
    (String) The user ID that updated the workspace.
    XGithubToken string
    appliedShareddataIds List<String>
    List of applied shared dataset ID.
    catalogRef SchematicsWorkspaceCatalogRef
    Information about the software template that you chose from the IBM Cloud catalog. This information is returned for IBM Cloud catalog offerings only. MaxItems:1. Nested scheme for catalog_ref:
    createdAt String
    (String) The timestamp when the workspace was created.
    createdBy String
    (String) The user ID that created the workspace.
    crn String
    (Optional, String) The workspace CRN.
    description String
    The description of the workspace.
    frozen Boolean
    If set to true, the workspace is frozen and changes to the workspace are disabled.
    frozenAt String
    The timestamp when the workspace was frozen.
    frozenBy String
    The user ID that froze the workspace.
    lastHealthCheckAt String
    (String) The timestamp when the last health check was performed by Schematics.
    location String
    The location where you want to create your Schematics workspace and run the Schematics jobs. The location that you enter must match the API endpoint that you use. For example, if you use the Frankfurt API endpoint, you must specify eu-de as your location. If you use an API endpoint for a geography and you do not specify a location, Schematics determines the location based on availability.
    locked Boolean
    If set to true, the workspace is locked and disabled for changes.
    lockedBy String
    The user ID that initiated a resource-related job, such as applying or destroying resources, that locked the workspace.
    lockedTime String
    The timestamp when the workspace was locked.
    name String
    resourceGroup String
    The ID of the resource group where you want to provision the workspace.
    runtimeDatas List<SchematicsWorkspaceRuntimeData>
    (Optional, List) Information about the provisioning engine, state file, and runtime logs. Nested scheme for runtime_data:
    schematicsWorkspaceId String
    sharedData SchematicsWorkspaceSharedData
    status String
    statusCode String
    (String) The success or error code that was returned for the last plan, apply, or destroy job that ran against your workspace.
    statusMsg String
    (String) The success or error message that was returned for the last plan, apply, or destroy job that ran against your workspace.
    tags List<String>
    A list of tags that are associated with the workspace.
    templateEnvSettings List<Map<String,String>>
    templateGitBranch String
    The repository branch.
    templateGitFolder String
    templateGitHasUploadedgitrepotar Boolean
    Has uploaded git repo tar
    templateGitRelease String
    The repository release.
    templateGitRepoShaValue String
    The repository SHA value.
    templateGitRepoUrl String
    The repository URL.
    templateGitUrl String
    The source URL.
    templateInitStateFile String
    templateInputs List<SchematicsWorkspaceTemplateInput>
    VariablesRequest -. Nested scheme for variablestore:
    templateRef String
    Workspace template ref.
    templateType String
    templateUninstallScriptName String
    Uninstall script name.
    templateValues String
    templateValuesMetadatas List<SchematicsWorkspaceTemplateValuesMetadata>
    List of values metadata. Nested scheme for template_values_metadata:
    updatedAt String
    (String) The timestamp when the workspace was last updated.
    updatedBy String
    (String) The user ID that updated the workspace.
    xGithubToken String
    appliedShareddataIds string[]
    List of applied shared dataset ID.
    catalogRef SchematicsWorkspaceCatalogRef
    Information about the software template that you chose from the IBM Cloud catalog. This information is returned for IBM Cloud catalog offerings only. MaxItems:1. Nested scheme for catalog_ref:
    createdAt string
    (String) The timestamp when the workspace was created.
    createdBy string
    (String) The user ID that created the workspace.
    crn string
    (Optional, String) The workspace CRN.
    description string
    The description of the workspace.
    frozen boolean
    If set to true, the workspace is frozen and changes to the workspace are disabled.
    frozenAt string
    The timestamp when the workspace was frozen.
    frozenBy string
    The user ID that froze the workspace.
    lastHealthCheckAt string
    (String) The timestamp when the last health check was performed by Schematics.
    location string
    The location where you want to create your Schematics workspace and run the Schematics jobs. The location that you enter must match the API endpoint that you use. For example, if you use the Frankfurt API endpoint, you must specify eu-de as your location. If you use an API endpoint for a geography and you do not specify a location, Schematics determines the location based on availability.
    locked boolean
    If set to true, the workspace is locked and disabled for changes.
    lockedBy string
    The user ID that initiated a resource-related job, such as applying or destroying resources, that locked the workspace.
    lockedTime string
    The timestamp when the workspace was locked.
    name string
    resourceGroup string
    The ID of the resource group where you want to provision the workspace.
    runtimeDatas SchematicsWorkspaceRuntimeData[]
    (Optional, List) Information about the provisioning engine, state file, and runtime logs. Nested scheme for runtime_data:
    schematicsWorkspaceId string
    sharedData SchematicsWorkspaceSharedData
    status string
    statusCode string
    (String) The success or error code that was returned for the last plan, apply, or destroy job that ran against your workspace.
    statusMsg string
    (String) The success or error message that was returned for the last plan, apply, or destroy job that ran against your workspace.
    tags string[]
    A list of tags that are associated with the workspace.
    templateEnvSettings {[key: string]: string}[]
    templateGitBranch string
    The repository branch.
    templateGitFolder string
    templateGitHasUploadedgitrepotar boolean
    Has uploaded git repo tar
    templateGitRelease string
    The repository release.
    templateGitRepoShaValue string
    The repository SHA value.
    templateGitRepoUrl string
    The repository URL.
    templateGitUrl string
    The source URL.
    templateInitStateFile string
    templateInputs SchematicsWorkspaceTemplateInput[]
    VariablesRequest -. Nested scheme for variablestore:
    templateRef string
    Workspace template ref.
    templateType string
    templateUninstallScriptName string
    Uninstall script name.
    templateValues string
    templateValuesMetadatas SchematicsWorkspaceTemplateValuesMetadata[]
    List of values metadata. Nested scheme for template_values_metadata:
    updatedAt string
    (String) The timestamp when the workspace was last updated.
    updatedBy string
    (String) The user ID that updated the workspace.
    xGithubToken string
    applied_shareddata_ids Sequence[str]
    List of applied shared dataset ID.
    catalog_ref SchematicsWorkspaceCatalogRefArgs
    Information about the software template that you chose from the IBM Cloud catalog. This information is returned for IBM Cloud catalog offerings only. MaxItems:1. Nested scheme for catalog_ref:
    created_at str
    (String) The timestamp when the workspace was created.
    created_by str
    (String) The user ID that created the workspace.
    crn str
    (Optional, String) The workspace CRN.
    description str
    The description of the workspace.
    frozen bool
    If set to true, the workspace is frozen and changes to the workspace are disabled.
    frozen_at str
    The timestamp when the workspace was frozen.
    frozen_by str
    The user ID that froze the workspace.
    last_health_check_at str
    (String) The timestamp when the last health check was performed by Schematics.
    location str
    The location where you want to create your Schematics workspace and run the Schematics jobs. The location that you enter must match the API endpoint that you use. For example, if you use the Frankfurt API endpoint, you must specify eu-de as your location. If you use an API endpoint for a geography and you do not specify a location, Schematics determines the location based on availability.
    locked bool
    If set to true, the workspace is locked and disabled for changes.
    locked_by str
    The user ID that initiated a resource-related job, such as applying or destroying resources, that locked the workspace.
    locked_time str
    The timestamp when the workspace was locked.
    name str
    resource_group str
    The ID of the resource group where you want to provision the workspace.
    runtime_datas Sequence[SchematicsWorkspaceRuntimeDataArgs]
    (Optional, List) Information about the provisioning engine, state file, and runtime logs. Nested scheme for runtime_data:
    schematics_workspace_id str
    shared_data SchematicsWorkspaceSharedDataArgs
    status str
    status_code str
    (String) The success or error code that was returned for the last plan, apply, or destroy job that ran against your workspace.
    status_msg str
    (String) The success or error message that was returned for the last plan, apply, or destroy job that ran against your workspace.
    tags Sequence[str]
    A list of tags that are associated with the workspace.
    template_env_settings Sequence[Mapping[str, str]]
    template_git_branch str
    The repository branch.
    template_git_folder str
    template_git_has_uploadedgitrepotar bool
    Has uploaded git repo tar
    template_git_release str
    The repository release.
    template_git_repo_sha_value str
    The repository SHA value.
    template_git_repo_url str
    The repository URL.
    template_git_url str
    The source URL.
    template_init_state_file str
    template_inputs Sequence[SchematicsWorkspaceTemplateInputArgs]
    VariablesRequest -. Nested scheme for variablestore:
    template_ref str
    Workspace template ref.
    template_type str
    template_uninstall_script_name str
    Uninstall script name.
    template_values str
    template_values_metadatas Sequence[SchematicsWorkspaceTemplateValuesMetadataArgs]
    List of values metadata. Nested scheme for template_values_metadata:
    updated_at str
    (String) The timestamp when the workspace was last updated.
    updated_by str
    (String) The user ID that updated the workspace.
    x_github_token str
    appliedShareddataIds List<String>
    List of applied shared dataset ID.
    catalogRef Property Map
    Information about the software template that you chose from the IBM Cloud catalog. This information is returned for IBM Cloud catalog offerings only. MaxItems:1. Nested scheme for catalog_ref:
    createdAt String
    (String) The timestamp when the workspace was created.
    createdBy String
    (String) The user ID that created the workspace.
    crn String
    (Optional, String) The workspace CRN.
    description String
    The description of the workspace.
    frozen Boolean
    If set to true, the workspace is frozen and changes to the workspace are disabled.
    frozenAt String
    The timestamp when the workspace was frozen.
    frozenBy String
    The user ID that froze the workspace.
    lastHealthCheckAt String
    (String) The timestamp when the last health check was performed by Schematics.
    location String
    The location where you want to create your Schematics workspace and run the Schematics jobs. The location that you enter must match the API endpoint that you use. For example, if you use the Frankfurt API endpoint, you must specify eu-de as your location. If you use an API endpoint for a geography and you do not specify a location, Schematics determines the location based on availability.
    locked Boolean
    If set to true, the workspace is locked and disabled for changes.
    lockedBy String
    The user ID that initiated a resource-related job, such as applying or destroying resources, that locked the workspace.
    lockedTime String
    The timestamp when the workspace was locked.
    name String
    resourceGroup String
    The ID of the resource group where you want to provision the workspace.
    runtimeDatas List<Property Map>
    (Optional, List) Information about the provisioning engine, state file, and runtime logs. Nested scheme for runtime_data:
    schematicsWorkspaceId String
    sharedData Property Map
    status String
    statusCode String
    (String) The success or error code that was returned for the last plan, apply, or destroy job that ran against your workspace.
    statusMsg String
    (String) The success or error message that was returned for the last plan, apply, or destroy job that ran against your workspace.
    tags List<String>
    A list of tags that are associated with the workspace.
    templateEnvSettings List<Map<String>>
    templateGitBranch String
    The repository branch.
    templateGitFolder String
    templateGitHasUploadedgitrepotar Boolean
    Has uploaded git repo tar
    templateGitRelease String
    The repository release.
    templateGitRepoShaValue String
    The repository SHA value.
    templateGitRepoUrl String
    The repository URL.
    templateGitUrl String
    The source URL.
    templateInitStateFile String
    templateInputs List<Property Map>
    VariablesRequest -. Nested scheme for variablestore:
    templateRef String
    Workspace template ref.
    templateType String
    templateUninstallScriptName String
    Uninstall script name.
    templateValues String
    templateValuesMetadatas List<Property Map>
    List of values metadata. Nested scheme for template_values_metadata:
    updatedAt String
    (String) The timestamp when the workspace was last updated.
    updatedBy String
    (String) The user ID that updated the workspace.
    xGithubToken String

    Supporting Types

    SchematicsWorkspaceCatalogRef, SchematicsWorkspaceCatalogRefArgs

    DryRun bool
    Dry run.
    ItemIconUrl string
    The URL to the icon of the software template in the IBM Cloud catalog.
    ItemId string
    The ID of the software template that you chose to install from the IBM Cloud catalog. This software is provisioned with Schematics.
    ItemName string
    The name of the software that you chose to install from the IBM Cloud catalog.
    ItemReadmeUrl string
    The URL to the readme file of the software template in the IBM Cloud catalog.
    ItemUrl string
    The URL to the software template in the IBM Cloud catalog.
    LaunchUrl string
    The URL to the dashboard to access your software.
    OfferingVersion string
    The version of the software template that you chose to install from the IBM Cloud catalog.
    OwningAccount string
    Owning account ID of the catalog.
    DryRun bool
    Dry run.
    ItemIconUrl string
    The URL to the icon of the software template in the IBM Cloud catalog.
    ItemId string
    The ID of the software template that you chose to install from the IBM Cloud catalog. This software is provisioned with Schematics.
    ItemName string
    The name of the software that you chose to install from the IBM Cloud catalog.
    ItemReadmeUrl string
    The URL to the readme file of the software template in the IBM Cloud catalog.
    ItemUrl string
    The URL to the software template in the IBM Cloud catalog.
    LaunchUrl string
    The URL to the dashboard to access your software.
    OfferingVersion string
    The version of the software template that you chose to install from the IBM Cloud catalog.
    OwningAccount string
    Owning account ID of the catalog.
    dryRun Boolean
    Dry run.
    itemIconUrl String
    The URL to the icon of the software template in the IBM Cloud catalog.
    itemId String
    The ID of the software template that you chose to install from the IBM Cloud catalog. This software is provisioned with Schematics.
    itemName String
    The name of the software that you chose to install from the IBM Cloud catalog.
    itemReadmeUrl String
    The URL to the readme file of the software template in the IBM Cloud catalog.
    itemUrl String
    The URL to the software template in the IBM Cloud catalog.
    launchUrl String
    The URL to the dashboard to access your software.
    offeringVersion String
    The version of the software template that you chose to install from the IBM Cloud catalog.
    owningAccount String
    Owning account ID of the catalog.
    dryRun boolean
    Dry run.
    itemIconUrl string
    The URL to the icon of the software template in the IBM Cloud catalog.
    itemId string
    The ID of the software template that you chose to install from the IBM Cloud catalog. This software is provisioned with Schematics.
    itemName string
    The name of the software that you chose to install from the IBM Cloud catalog.
    itemReadmeUrl string
    The URL to the readme file of the software template in the IBM Cloud catalog.
    itemUrl string
    The URL to the software template in the IBM Cloud catalog.
    launchUrl string
    The URL to the dashboard to access your software.
    offeringVersion string
    The version of the software template that you chose to install from the IBM Cloud catalog.
    owningAccount string
    Owning account ID of the catalog.
    dry_run bool
    Dry run.
    item_icon_url str
    The URL to the icon of the software template in the IBM Cloud catalog.
    item_id str
    The ID of the software template that you chose to install from the IBM Cloud catalog. This software is provisioned with Schematics.
    item_name str
    The name of the software that you chose to install from the IBM Cloud catalog.
    item_readme_url str
    The URL to the readme file of the software template in the IBM Cloud catalog.
    item_url str
    The URL to the software template in the IBM Cloud catalog.
    launch_url str
    The URL to the dashboard to access your software.
    offering_version str
    The version of the software template that you chose to install from the IBM Cloud catalog.
    owning_account str
    Owning account ID of the catalog.
    dryRun Boolean
    Dry run.
    itemIconUrl String
    The URL to the icon of the software template in the IBM Cloud catalog.
    itemId String
    The ID of the software template that you chose to install from the IBM Cloud catalog. This software is provisioned with Schematics.
    itemName String
    The name of the software that you chose to install from the IBM Cloud catalog.
    itemReadmeUrl String
    The URL to the readme file of the software template in the IBM Cloud catalog.
    itemUrl String
    The URL to the software template in the IBM Cloud catalog.
    launchUrl String
    The URL to the dashboard to access your software.
    offeringVersion String
    The version of the software template that you chose to install from the IBM Cloud catalog.
    owningAccount String
    Owning account ID of the catalog.

    SchematicsWorkspaceRuntimeData, SchematicsWorkspaceRuntimeDataArgs

    EngineCmd string
    EngineName string
    EngineVersion string
    (Optional, String) The version of the provisioning engine that was used.
    Id string
    LogStoreUrl string
    (Optional, String) The URL to access the logs that were created during the creation, update, or deletion of your IBM Cloud resources.
    OutputValues List<ImmutableDictionary<string, string>>
    (Optional, List) List of Output values.
    Resources List<ImmutableDictionary<string, string>>
    (Optional, List) List of resources.
    StateStoreUrl string
    EngineCmd string
    EngineName string
    EngineVersion string
    (Optional, String) The version of the provisioning engine that was used.
    Id string
    LogStoreUrl string
    (Optional, String) The URL to access the logs that were created during the creation, update, or deletion of your IBM Cloud resources.
    OutputValues []map[string]string
    (Optional, List) List of Output values.
    Resources []map[string]string
    (Optional, List) List of resources.
    StateStoreUrl string
    engineCmd String
    engineName String
    engineVersion String
    (Optional, String) The version of the provisioning engine that was used.
    id String
    logStoreUrl String
    (Optional, String) The URL to access the logs that were created during the creation, update, or deletion of your IBM Cloud resources.
    outputValues List<Map<String,String>>
    (Optional, List) List of Output values.
    resources List<Map<String,String>>
    (Optional, List) List of resources.
    stateStoreUrl String
    engineCmd string
    engineName string
    engineVersion string
    (Optional, String) The version of the provisioning engine that was used.
    id string
    logStoreUrl string
    (Optional, String) The URL to access the logs that were created during the creation, update, or deletion of your IBM Cloud resources.
    outputValues {[key: string]: string}[]
    (Optional, List) List of Output values.
    resources {[key: string]: string}[]
    (Optional, List) List of resources.
    stateStoreUrl string
    engine_cmd str
    engine_name str
    engine_version str
    (Optional, String) The version of the provisioning engine that was used.
    id str
    log_store_url str
    (Optional, String) The URL to access the logs that were created during the creation, update, or deletion of your IBM Cloud resources.
    output_values Sequence[Mapping[str, str]]
    (Optional, List) List of Output values.
    resources Sequence[Mapping[str, str]]
    (Optional, List) List of resources.
    state_store_url str
    engineCmd String
    engineName String
    engineVersion String
    (Optional, String) The version of the provisioning engine that was used.
    id String
    logStoreUrl String
    (Optional, String) The URL to access the logs that were created during the creation, update, or deletion of your IBM Cloud resources.
    outputValues List<Map<String>>
    (Optional, List) List of Output values.
    resources List<Map<String>>
    (Optional, List) List of resources.
    stateStoreUrl String

    SchematicsWorkspaceSharedData, SchematicsWorkspaceSharedDataArgs

    ClusterCreatedOn string
    Cluster created on.
    ClusterId string
    The ID of the cluster where you want to provision the resources of all IBM Cloud catalog templates that are included in the catalog offering.
    ClusterName string
    The cluster name.
    ClusterType string
    The cluster type.
    EntitlementKeys List<ImmutableDictionary<string, string>>
    The entitlement key that you want to use to install IBM Cloud entitled software.
    Namespace string
    The Kubernetes namespace or OpenShift project where the resources of all IBM Cloud catalog templates that are included in the catalog offering are deployed into.
    Region string
    The IBM Cloud region that you want to use for the resources of all IBM Cloud catalog templates that are included in the catalog offering.
    ResourceGroupId string
    The ID of the resource group that you want to use for the resources of all IBM Cloud catalog templates that are included in the catalog offering.
    WorkerCount double
    The cluster worker count.
    WorkerMachineType string
    The cluster worker type.
    ClusterCreatedOn string
    Cluster created on.
    ClusterId string
    The ID of the cluster where you want to provision the resources of all IBM Cloud catalog templates that are included in the catalog offering.
    ClusterName string
    The cluster name.
    ClusterType string
    The cluster type.
    EntitlementKeys []map[string]string
    The entitlement key that you want to use to install IBM Cloud entitled software.
    Namespace string
    The Kubernetes namespace or OpenShift project where the resources of all IBM Cloud catalog templates that are included in the catalog offering are deployed into.
    Region string
    The IBM Cloud region that you want to use for the resources of all IBM Cloud catalog templates that are included in the catalog offering.
    ResourceGroupId string
    The ID of the resource group that you want to use for the resources of all IBM Cloud catalog templates that are included in the catalog offering.
    WorkerCount float64
    The cluster worker count.
    WorkerMachineType string
    The cluster worker type.
    clusterCreatedOn String
    Cluster created on.
    clusterId String
    The ID of the cluster where you want to provision the resources of all IBM Cloud catalog templates that are included in the catalog offering.
    clusterName String
    The cluster name.
    clusterType String
    The cluster type.
    entitlementKeys List<Map<String,String>>
    The entitlement key that you want to use to install IBM Cloud entitled software.
    namespace String
    The Kubernetes namespace or OpenShift project where the resources of all IBM Cloud catalog templates that are included in the catalog offering are deployed into.
    region String
    The IBM Cloud region that you want to use for the resources of all IBM Cloud catalog templates that are included in the catalog offering.
    resourceGroupId String
    The ID of the resource group that you want to use for the resources of all IBM Cloud catalog templates that are included in the catalog offering.
    workerCount Double
    The cluster worker count.
    workerMachineType String
    The cluster worker type.
    clusterCreatedOn string
    Cluster created on.
    clusterId string
    The ID of the cluster where you want to provision the resources of all IBM Cloud catalog templates that are included in the catalog offering.
    clusterName string
    The cluster name.
    clusterType string
    The cluster type.
    entitlementKeys {[key: string]: string}[]
    The entitlement key that you want to use to install IBM Cloud entitled software.
    namespace string
    The Kubernetes namespace or OpenShift project where the resources of all IBM Cloud catalog templates that are included in the catalog offering are deployed into.
    region string
    The IBM Cloud region that you want to use for the resources of all IBM Cloud catalog templates that are included in the catalog offering.
    resourceGroupId string
    The ID of the resource group that you want to use for the resources of all IBM Cloud catalog templates that are included in the catalog offering.
    workerCount number
    The cluster worker count.
    workerMachineType string
    The cluster worker type.
    cluster_created_on str
    Cluster created on.
    cluster_id str
    The ID of the cluster where you want to provision the resources of all IBM Cloud catalog templates that are included in the catalog offering.
    cluster_name str
    The cluster name.
    cluster_type str
    The cluster type.
    entitlement_keys Sequence[Mapping[str, str]]
    The entitlement key that you want to use to install IBM Cloud entitled software.
    namespace str
    The Kubernetes namespace or OpenShift project where the resources of all IBM Cloud catalog templates that are included in the catalog offering are deployed into.
    region str
    The IBM Cloud region that you want to use for the resources of all IBM Cloud catalog templates that are included in the catalog offering.
    resource_group_id str
    The ID of the resource group that you want to use for the resources of all IBM Cloud catalog templates that are included in the catalog offering.
    worker_count float
    The cluster worker count.
    worker_machine_type str
    The cluster worker type.
    clusterCreatedOn String
    Cluster created on.
    clusterId String
    The ID of the cluster where you want to provision the resources of all IBM Cloud catalog templates that are included in the catalog offering.
    clusterName String
    The cluster name.
    clusterType String
    The cluster type.
    entitlementKeys List<Map<String>>
    The entitlement key that you want to use to install IBM Cloud entitled software.
    namespace String
    The Kubernetes namespace or OpenShift project where the resources of all IBM Cloud catalog templates that are included in the catalog offering are deployed into.
    region String
    The IBM Cloud region that you want to use for the resources of all IBM Cloud catalog templates that are included in the catalog offering.
    resourceGroupId String
    The ID of the resource group that you want to use for the resources of all IBM Cloud catalog templates that are included in the catalog offering.
    workerCount Number
    The cluster worker count.
    workerMachineType String
    The cluster worker type.

    SchematicsWorkspaceTemplateInput, SchematicsWorkspaceTemplateInputArgs

    Name string
    The name of the variable.
    Type string
    Value string
    Description string
    The description of your input variable.
    Secure bool
    If set to true, the value of your input variable is protected and not returned in your API response.
    UseDefault bool
    Variable uses default value; and is not over-ridden.
    Name string
    The name of the variable.
    Type string
    Value string
    Description string
    The description of your input variable.
    Secure bool
    If set to true, the value of your input variable is protected and not returned in your API response.
    UseDefault bool
    Variable uses default value; and is not over-ridden.
    name String
    The name of the variable.
    type String
    value String
    description String
    The description of your input variable.
    secure Boolean
    If set to true, the value of your input variable is protected and not returned in your API response.
    useDefault Boolean
    Variable uses default value; and is not over-ridden.
    name string
    The name of the variable.
    type string
    value string
    description string
    The description of your input variable.
    secure boolean
    If set to true, the value of your input variable is protected and not returned in your API response.
    useDefault boolean
    Variable uses default value; and is not over-ridden.
    name str
    The name of the variable.
    type str
    value str
    description str
    The description of your input variable.
    secure bool
    If set to true, the value of your input variable is protected and not returned in your API response.
    use_default bool
    Variable uses default value; and is not over-ridden.
    name String
    The name of the variable.
    type String
    value String
    description String
    The description of your input variable.
    secure Boolean
    If set to true, the value of your input variable is protected and not returned in your API response.
    useDefault Boolean
    Variable uses default value; and is not over-ridden.

    SchematicsWorkspaceTemplateValuesMetadata, SchematicsWorkspaceTemplateValuesMetadataArgs

    Aliases List<string>
    The list of aliases for the variable name.
    CloudDataType string
    Cloud data type of the variable. eg. resource_group_id, region, vpc_id.
    Default string
    Default value for the variable only if the override value is not specified.
    Description string
    The description of the meta data.
    GroupBy string
    The display name of the group this variable belongs to.
    Hidden bool
    If true, the variable is not displayed on UI or Command line.
    Immutable bool
    Is the variable readonly ?.
    LinkStatus string
    The status of the link.

    • Constraints: Allowable values are: normal, broken.
    Matches string
    The regex for the variable value.
    MaxLength double
    The maximum length of the variable value. Applicable for the string type.
    MaxValue double
    The maximum value of the variable. Applicable for the integer type.
    MinLength double
    The minimum length of the variable value. Applicable for the string type.
    MinValue double
    The minimum value of the variable. Applicable for the integer type.
    Name string
    Name of the variable.
    Options List<string>
    The list of possible values for this variable. If type is integer or date, then the array of string is converted to array of integers or date during the runtime.
    Position double
    The relative position of this variable in a list.
    Required bool
    If the variable required?.
    Secure bool
    Is the variable secure or sensitive ?.
    Source string
    The source of this meta-data.
    Type string
    Type of the variable.

    • Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex, link.
    Aliases []string
    The list of aliases for the variable name.
    CloudDataType string
    Cloud data type of the variable. eg. resource_group_id, region, vpc_id.
    Default string
    Default value for the variable only if the override value is not specified.
    Description string
    The description of the meta data.
    GroupBy string
    The display name of the group this variable belongs to.
    Hidden bool
    If true, the variable is not displayed on UI or Command line.
    Immutable bool
    Is the variable readonly ?.
    LinkStatus string
    The status of the link.

    • Constraints: Allowable values are: normal, broken.
    Matches string
    The regex for the variable value.
    MaxLength float64
    The maximum length of the variable value. Applicable for the string type.
    MaxValue float64
    The maximum value of the variable. Applicable for the integer type.
    MinLength float64
    The minimum length of the variable value. Applicable for the string type.
    MinValue float64
    The minimum value of the variable. Applicable for the integer type.
    Name string
    Name of the variable.
    Options []string
    The list of possible values for this variable. If type is integer or date, then the array of string is converted to array of integers or date during the runtime.
    Position float64
    The relative position of this variable in a list.
    Required bool
    If the variable required?.
    Secure bool
    Is the variable secure or sensitive ?.
    Source string
    The source of this meta-data.
    Type string
    Type of the variable.

    • Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex, link.
    aliases List<String>
    The list of aliases for the variable name.
    cloudDataType String
    Cloud data type of the variable. eg. resource_group_id, region, vpc_id.
    default_ String
    Default value for the variable only if the override value is not specified.
    description String
    The description of the meta data.
    groupBy String
    The display name of the group this variable belongs to.
    hidden Boolean
    If true, the variable is not displayed on UI or Command line.
    immutable Boolean
    Is the variable readonly ?.
    linkStatus String
    The status of the link.

    • Constraints: Allowable values are: normal, broken.
    matches String
    The regex for the variable value.
    maxLength Double
    The maximum length of the variable value. Applicable for the string type.
    maxValue Double
    The maximum value of the variable. Applicable for the integer type.
    minLength Double
    The minimum length of the variable value. Applicable for the string type.
    minValue Double
    The minimum value of the variable. Applicable for the integer type.
    name String
    Name of the variable.
    options List<String>
    The list of possible values for this variable. If type is integer or date, then the array of string is converted to array of integers or date during the runtime.
    position Double
    The relative position of this variable in a list.
    required Boolean
    If the variable required?.
    secure Boolean
    Is the variable secure or sensitive ?.
    source String
    The source of this meta-data.
    type String
    Type of the variable.

    • Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex, link.
    aliases string[]
    The list of aliases for the variable name.
    cloudDataType string
    Cloud data type of the variable. eg. resource_group_id, region, vpc_id.
    default string
    Default value for the variable only if the override value is not specified.
    description string
    The description of the meta data.
    groupBy string
    The display name of the group this variable belongs to.
    hidden boolean
    If true, the variable is not displayed on UI or Command line.
    immutable boolean
    Is the variable readonly ?.
    linkStatus string
    The status of the link.

    • Constraints: Allowable values are: normal, broken.
    matches string
    The regex for the variable value.
    maxLength number
    The maximum length of the variable value. Applicable for the string type.
    maxValue number
    The maximum value of the variable. Applicable for the integer type.
    minLength number
    The minimum length of the variable value. Applicable for the string type.
    minValue number
    The minimum value of the variable. Applicable for the integer type.
    name string
    Name of the variable.
    options string[]
    The list of possible values for this variable. If type is integer or date, then the array of string is converted to array of integers or date during the runtime.
    position number
    The relative position of this variable in a list.
    required boolean
    If the variable required?.
    secure boolean
    Is the variable secure or sensitive ?.
    source string
    The source of this meta-data.
    type string
    Type of the variable.

    • Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex, link.
    aliases Sequence[str]
    The list of aliases for the variable name.
    cloud_data_type str
    Cloud data type of the variable. eg. resource_group_id, region, vpc_id.
    default str
    Default value for the variable only if the override value is not specified.
    description str
    The description of the meta data.
    group_by str
    The display name of the group this variable belongs to.
    hidden bool
    If true, the variable is not displayed on UI or Command line.
    immutable bool
    Is the variable readonly ?.
    link_status str
    The status of the link.

    • Constraints: Allowable values are: normal, broken.
    matches str
    The regex for the variable value.
    max_length float
    The maximum length of the variable value. Applicable for the string type.
    max_value float
    The maximum value of the variable. Applicable for the integer type.
    min_length float
    The minimum length of the variable value. Applicable for the string type.
    min_value float
    The minimum value of the variable. Applicable for the integer type.
    name str
    Name of the variable.
    options Sequence[str]
    The list of possible values for this variable. If type is integer or date, then the array of string is converted to array of integers or date during the runtime.
    position float
    The relative position of this variable in a list.
    required bool
    If the variable required?.
    secure bool
    Is the variable secure or sensitive ?.
    source str
    The source of this meta-data.
    type str
    Type of the variable.

    • Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex, link.
    aliases List<String>
    The list of aliases for the variable name.
    cloudDataType String
    Cloud data type of the variable. eg. resource_group_id, region, vpc_id.
    default String
    Default value for the variable only if the override value is not specified.
    description String
    The description of the meta data.
    groupBy String
    The display name of the group this variable belongs to.
    hidden Boolean
    If true, the variable is not displayed on UI or Command line.
    immutable Boolean
    Is the variable readonly ?.
    linkStatus String
    The status of the link.

    • Constraints: Allowable values are: normal, broken.
    matches String
    The regex for the variable value.
    maxLength Number
    The maximum length of the variable value. Applicable for the string type.
    maxValue Number
    The maximum value of the variable. Applicable for the integer type.
    minLength Number
    The minimum length of the variable value. Applicable for the string type.
    minValue Number
    The minimum value of the variable. Applicable for the integer type.
    name String
    Name of the variable.
    options List<String>
    The list of possible values for this variable. If type is integer or date, then the array of string is converted to array of integers or date during the runtime.
    position Number
    The relative position of this variable in a list.
    required Boolean
    If the variable required?.
    secure Boolean
    Is the variable secure or sensitive ?.
    source String
    The source of this meta-data.
    type String
    Type of the variable.

    • Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex, link.

    Import

    You can import the ibm_schematics_workspace resource by using id. The unique identifier of the workspace.

    Syntax

    $ pulumi import ibm:index/schematicsWorkspace:SchematicsWorkspace schematics_workspace <id>

    Note

    This resource can perform create, read, update and delete operations of schematics workspace. Other schematics operations such as Plan and Apply which are available in IBM Cloud Schematics console are currently not supported.

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

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm