Docs Home
Alibaba Cloud v3.75.0 published on Friday, Mar 7, 2025 by Pulumi
alicloud.pai.WorkspaceRun
Explore with Pulumi AI
Provides a PAI Workspace Run resource.
For information about PAI Workspace Run and how to use it, see What is Run.
NOTE: Available since v1.236.0.
Create WorkspaceRun Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new WorkspaceRun(name: string, args: WorkspaceRunArgs, opts?: CustomResourceOptions);@overload
def WorkspaceRun(resource_name: str,
args: WorkspaceRunArgs,
opts: Optional[ResourceOptions] = None)
@overload
def WorkspaceRun(resource_name: str,
opts: Optional[ResourceOptions] = None,
experiment_id: Optional[str] = None,
run_name: Optional[str] = None,
source_id: Optional[str] = None,
source_type: Optional[str] = None)func NewWorkspaceRun(ctx *Context, name string, args WorkspaceRunArgs, opts ...ResourceOption) (*WorkspaceRun, error)public WorkspaceRun(string name, WorkspaceRunArgs args, CustomResourceOptions? opts = null)
public WorkspaceRun(String name, WorkspaceRunArgs args)
public WorkspaceRun(String name, WorkspaceRunArgs args, CustomResourceOptions options)
type: alicloud:pai:WorkspaceRun
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 WorkspaceRunArgs
- 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 WorkspaceRunArgs
- 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 WorkspaceRunArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args WorkspaceRunArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args WorkspaceRunArgs
- 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 workspaceRunResource = new AliCloud.Pai.WorkspaceRun("workspaceRunResource", new()
{
ExperimentId = "string",
RunName = "string",
SourceId = "string",
SourceType = "string",
});
example, err := pai.NewWorkspaceRun(ctx, "workspaceRunResource", &pai.WorkspaceRunArgs{
ExperimentId: pulumi.String("string"),
RunName: pulumi.String("string"),
SourceId: pulumi.String("string"),
SourceType: pulumi.String("string"),
})
var workspaceRunResource = new WorkspaceRun("workspaceRunResource", WorkspaceRunArgs.builder()
.experimentId("string")
.runName("string")
.sourceId("string")
.sourceType("string")
.build());
workspace_run_resource = alicloud.pai.WorkspaceRun("workspaceRunResource",
experiment_id="string",
run_name="string",
source_id="string",
source_type="string")
const workspaceRunResource = new alicloud.pai.WorkspaceRun("workspaceRunResource", {
experimentId: "string",
runName: "string",
sourceId: "string",
sourceType: "string",
});
type: alicloud:pai:WorkspaceRun
properties:
experimentId: string
runName: string
sourceId: string
sourceType: string
WorkspaceRun 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 WorkspaceRun resource accepts the following input properties:
- Experiment
Id string - Resource attribute field of the experiment ID to which Run belongs
- Run
Name string - The name of the resource
- Source
Id string - Attribute Resource field representing the source task ID
- Source
Type string - Resource attribute fields representing the source type
- Experiment
Id string - Resource attribute field of the experiment ID to which Run belongs
- Run
Name string - The name of the resource
- Source
Id string - Attribute Resource field representing the source task ID
- Source
Type string - Resource attribute fields representing the source type
- experiment
Id String - Resource attribute field of the experiment ID to which Run belongs
- run
Name String - The name of the resource
- source
Id String - Attribute Resource field representing the source task ID
- source
Type String - Resource attribute fields representing the source type
- experiment
Id string - Resource attribute field of the experiment ID to which Run belongs
- run
Name string - The name of the resource
- source
Id string - Attribute Resource field representing the source task ID
- source
Type string - Resource attribute fields representing the source type
- experiment_
id str - Resource attribute field of the experiment ID to which Run belongs
- run_
name str - The name of the resource
- source_
id str - Attribute Resource field representing the source task ID
- source_
type str - Resource attribute fields representing the source type
- experiment
Id String - Resource attribute field of the experiment ID to which Run belongs
- run
Name String - The name of the resource
- source
Id String - Attribute Resource field representing the source task ID
- source
Type String - Resource attribute fields representing the source type
Outputs
All input properties are implicitly available as output properties. Additionally, the WorkspaceRun resource produces the following output properties:
- Create
Time string - The creation time of the resource
- Id string
- The provider-assigned unique ID for this managed resource.
- Create
Time string - The creation time of the resource
- Id string
- The provider-assigned unique ID for this managed resource.
- create
Time String - The creation time of the resource
- id String
- The provider-assigned unique ID for this managed resource.
- create
Time string - The creation time of the resource
- id string
- The provider-assigned unique ID for this managed resource.
- create_
time str - The creation time of the resource
- id str
- The provider-assigned unique ID for this managed resource.
- create
Time String - The creation time of the resource
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing WorkspaceRun Resource
Get an existing WorkspaceRun 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?: WorkspaceRunState, opts?: CustomResourceOptions): WorkspaceRun@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
create_time: Optional[str] = None,
experiment_id: Optional[str] = None,
run_name: Optional[str] = None,
source_id: Optional[str] = None,
source_type: Optional[str] = None) -> WorkspaceRunfunc GetWorkspaceRun(ctx *Context, name string, id IDInput, state *WorkspaceRunState, opts ...ResourceOption) (*WorkspaceRun, error)public static WorkspaceRun Get(string name, Input<string> id, WorkspaceRunState? state, CustomResourceOptions? opts = null)public static WorkspaceRun get(String name, Output<String> id, WorkspaceRunState state, CustomResourceOptions options)resources: _: type: alicloud:pai:WorkspaceRun 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.
- Create
Time string - The creation time of the resource
- Experiment
Id string - Resource attribute field of the experiment ID to which Run belongs
- Run
Name string - The name of the resource
- Source
Id string - Attribute Resource field representing the source task ID
- Source
Type string - Resource attribute fields representing the source type
- Create
Time string - The creation time of the resource
- Experiment
Id string - Resource attribute field of the experiment ID to which Run belongs
- Run
Name string - The name of the resource
- Source
Id string - Attribute Resource field representing the source task ID
- Source
Type string - Resource attribute fields representing the source type
- create
Time String - The creation time of the resource
- experiment
Id String - Resource attribute field of the experiment ID to which Run belongs
- run
Name String - The name of the resource
- source
Id String - Attribute Resource field representing the source task ID
- source
Type String - Resource attribute fields representing the source type
- create
Time string - The creation time of the resource
- experiment
Id string - Resource attribute field of the experiment ID to which Run belongs
- run
Name string - The name of the resource
- source
Id string - Attribute Resource field representing the source task ID
- source
Type string - Resource attribute fields representing the source type
- create_
time str - The creation time of the resource
- experiment_
id str - Resource attribute field of the experiment ID to which Run belongs
- run_
name str - The name of the resource
- source_
id str - Attribute Resource field representing the source task ID
- source_
type str - Resource attribute fields representing the source type
- create
Time String - The creation time of the resource
- experiment
Id String - Resource attribute field of the experiment ID to which Run belongs
- run
Name String - The name of the resource
- source
Id String - Attribute Resource field representing the source task ID
- source
Type String - Resource attribute fields representing the source type
Import
PAI Workspace Run can be imported using the id, e.g.
$ pulumi import alicloud:pai/workspaceRun:WorkspaceRun example <id>
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Alibaba Cloud pulumi/pulumi-alicloud
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
alicloudTerraform Provider.