Docs
Packagesalicloud.oos.Execution
Explore with Pulumi AI
Provides a OOS Execution resource. For information about Alicloud OOS Execution and how to use it, see What is Resource Alicloud OOS Execution.
NOTE: Available in 1.93.0+.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;
return await Deployment.RunAsync(() =>
{
var @default = new AliCloud.Oos.Template("default", new()
{
Content = @" {
""FormatVersion"": ""OOS-2019-06-01"",
""Description"": ""Update Describe instances of given status"",
""Parameters"":{
""Status"":{
""Type"": ""String"",
""Description"": ""(Required) The status of the Ecs instance.""
}
},
""Tasks"": [
{
""Properties"" :{
""Parameters"":{
""Status"": ""{{ Status }}""
},
""API"": ""DescribeInstances"",
""Service"": ""Ecs""
},
""Name"": ""foo"",
""Action"": ""ACS::ExecuteApi""
}]
}
",
TemplateName = "test-name",
VersionName = "test",
Tags =
{
{ "Created", "TF" },
{ "For", "acceptance Test" },
},
});
var example = new AliCloud.Oos.Execution("example", new()
{
TemplateName = @default.TemplateName,
Description = "From TF Test",
Parameters = @" {""Status"":""Running""}
",
});
});
package main
import (
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/oos"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := oos.NewTemplate(ctx, "default", &oos.TemplateArgs{
Content: pulumi.String(` {
"FormatVersion": "OOS-2019-06-01",
"Description": "Update Describe instances of given status",
"Parameters":{
"Status":{
"Type": "String",
"Description": "(Required) The status of the Ecs instance."
}
},
"Tasks": [
{
"Properties" :{
"Parameters":{
"Status": "{{ Status }}"
},
"API": "DescribeInstances",
"Service": "Ecs"
},
"Name": "foo",
"Action": "ACS::ExecuteApi"
}]
}
`),
TemplateName: pulumi.String("test-name"),
VersionName: pulumi.String("test"),
Tags: pulumi.AnyMap{
"Created": pulumi.Any("TF"),
"For": pulumi.Any("acceptance Test"),
},
})
if err != nil {
return err
}
_, err = oos.NewExecution(ctx, "example", &oos.ExecutionArgs{
TemplateName: _default.TemplateName,
Description: pulumi.String("From TF Test"),
Parameters: pulumi.String(" {\"Status\":\"Running\"}\n"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.oos.Template;
import com.pulumi.alicloud.oos.TemplateArgs;
import com.pulumi.alicloud.oos.Execution;
import com.pulumi.alicloud.oos.ExecutionArgs;
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 default_ = new Template("default", TemplateArgs.builder()
.content("""
{
"FormatVersion": "OOS-2019-06-01",
"Description": "Update Describe instances of given status",
"Parameters":{
"Status":{
"Type": "String",
"Description": "(Required) The status of the Ecs instance."
}
},
"Tasks": [
{
"Properties" :{
"Parameters":{
"Status": "{{ Status }}"
},
"API": "DescribeInstances",
"Service": "Ecs"
},
"Name": "foo",
"Action": "ACS::ExecuteApi"
}]
}
""")
.templateName("test-name")
.versionName("test")
.tags(Map.ofEntries(
Map.entry("Created", "TF"),
Map.entry("For", "acceptance Test")
))
.build());
var example = new Execution("example", ExecutionArgs.builder()
.templateName(default_.templateName())
.description("From TF Test")
.parameters("""
{"Status":"Running"}
""")
.build());
}
}
import pulumi
import pulumi_alicloud as alicloud
default = alicloud.oos.Template("default",
content=""" {
"FormatVersion": "OOS-2019-06-01",
"Description": "Update Describe instances of given status",
"Parameters":{
"Status":{
"Type": "String",
"Description": "(Required) The status of the Ecs instance."
}
},
"Tasks": [
{
"Properties" :{
"Parameters":{
"Status": "{{ Status }}"
},
"API": "DescribeInstances",
"Service": "Ecs"
},
"Name": "foo",
"Action": "ACS::ExecuteApi"
}]
}
""",
template_name="test-name",
version_name="test",
tags={
"Created": "TF",
"For": "acceptance Test",
})
example = alicloud.oos.Execution("example",
template_name=default.template_name,
description="From TF Test",
parameters=" {\"Status\":\"Running\"}\n")
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const _default = new alicloud.oos.Template("default", {
content: ` {
"FormatVersion": "OOS-2019-06-01",
"Description": "Update Describe instances of given status",
"Parameters":{
"Status":{
"Type": "String",
"Description": "(Required) The status of the Ecs instance."
}
},
"Tasks": [
{
"Properties" :{
"Parameters":{
"Status": "{{ Status }}"
},
"API": "DescribeInstances",
"Service": "Ecs"
},
"Name": "foo",
"Action": "ACS::ExecuteApi"
}]
}
`,
templateName: "test-name",
versionName: "test",
tags: {
Created: "TF",
For: "acceptance Test",
},
});
const example = new alicloud.oos.Execution("example", {
templateName: _default.templateName,
description: "From TF Test",
parameters: " {\"Status\":\"Running\"}\n",
});
resources:
default:
type: alicloud:oos:Template
properties:
content: |2
{
"FormatVersion": "OOS-2019-06-01",
"Description": "Update Describe instances of given status",
"Parameters":{
"Status":{
"Type": "String",
"Description": "(Required) The status of the Ecs instance."
}
},
"Tasks": [
{
"Properties" :{
"Parameters":{
"Status": "{{ Status }}"
},
"API": "DescribeInstances",
"Service": "Ecs"
},
"Name": "foo",
"Action": "ACS::ExecuteApi"
}]
}
templateName: test-name
versionName: test
tags:
Created: TF
For: acceptance Test
example:
type: alicloud:oos:Execution
properties:
templateName: ${default.templateName}
description: From TF Test
parameters: |
{"Status":"Running"}
Create Execution Resource
new Execution(name: string, args: ExecutionArgs, opts?: CustomResourceOptions);@overload
def Execution(resource_name: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
loop_mode: Optional[str] = None,
mode: Optional[str] = None,
parameters: Optional[str] = None,
parent_execution_id: Optional[str] = None,
safety_check: Optional[str] = None,
template_content: Optional[str] = None,
template_name: Optional[str] = None,
template_version: Optional[str] = None)
@overload
def Execution(resource_name: str,
args: ExecutionArgs,
opts: Optional[ResourceOptions] = None)func NewExecution(ctx *Context, name string, args ExecutionArgs, opts ...ResourceOption) (*Execution, error)public Execution(string name, ExecutionArgs args, CustomResourceOptions? opts = null)
public Execution(String name, ExecutionArgs args)
public Execution(String name, ExecutionArgs args, CustomResourceOptions options)
type: alicloud:oos:Execution
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ExecutionArgs
- 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 ExecutionArgs
- 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 ExecutionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ExecutionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ExecutionArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Execution Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Execution resource accepts the following input properties:
- Template
Name string The name of execution template.
- Description string
The description of OOS Execution.
- Loop
Mode string The loop mode of OOS Execution.
- Mode string
The mode of OOS Execution. Valid:
Automatic,Debug. Default toAutomatic.- Parameters string
The parameters required by the template. Default to
{}.- Parent
Execution stringId The id of parent execution.
- Safety
Check string The mode of safety check.
- Template
Content string The content of template. When the user selects an existing template to create and execute a task, it is not necessary to pass in this field.
- Template
Version string The version of execution template.
- Template
Name string The name of execution template.
- Description string
The description of OOS Execution.
- Loop
Mode string The loop mode of OOS Execution.
- Mode string
The mode of OOS Execution. Valid:
Automatic,Debug. Default toAutomatic.- Parameters string
The parameters required by the template. Default to
{}.- Parent
Execution stringId The id of parent execution.
- Safety
Check string The mode of safety check.
- Template
Content string The content of template. When the user selects an existing template to create and execute a task, it is not necessary to pass in this field.
- Template
Version string The version of execution template.
- template
Name String The name of execution template.
- description String
The description of OOS Execution.
- loop
Mode String The loop mode of OOS Execution.
- mode String
The mode of OOS Execution. Valid:
Automatic,Debug. Default toAutomatic.- parameters String
The parameters required by the template. Default to
{}.- parent
Execution StringId The id of parent execution.
- safety
Check String The mode of safety check.
- template
Content String The content of template. When the user selects an existing template to create and execute a task, it is not necessary to pass in this field.
- template
Version String The version of execution template.
- template
Name string The name of execution template.
- description string
The description of OOS Execution.
- loop
Mode string The loop mode of OOS Execution.
- mode string
The mode of OOS Execution. Valid:
Automatic,Debug. Default toAutomatic.- parameters string
The parameters required by the template. Default to
{}.- parent
Execution stringId The id of parent execution.
- safety
Check string The mode of safety check.
- template
Content string The content of template. When the user selects an existing template to create and execute a task, it is not necessary to pass in this field.
- template
Version string The version of execution template.
- template_
name str The name of execution template.
- description str
The description of OOS Execution.
- loop_
mode str The loop mode of OOS Execution.
- mode str
The mode of OOS Execution. Valid:
Automatic,Debug. Default toAutomatic.- parameters str
The parameters required by the template. Default to
{}.- parent_
execution_ strid The id of parent execution.
- safety_
check str The mode of safety check.
- template_
content str The content of template. When the user selects an existing template to create and execute a task, it is not necessary to pass in this field.
- template_
version str The version of execution template.
- template
Name String The name of execution template.
- description String
The description of OOS Execution.
- loop
Mode String The loop mode of OOS Execution.
- mode String
The mode of OOS Execution. Valid:
Automatic,Debug. Default toAutomatic.- parameters String
The parameters required by the template. Default to
{}.- parent
Execution StringId The id of parent execution.
- safety
Check String The mode of safety check.
- template
Content String The content of template. When the user selects an existing template to create and execute a task, it is not necessary to pass in this field.
- template
Version String The version of execution template.
Outputs
All input properties are implicitly available as output properties. Additionally, the Execution resource produces the following output properties:
- Counters string
The counters of OOS Execution.
- Create
Date string The time when the execution was created.
- End
Date string The time when the execution was ended.
- Executed
By string The user who execute the template.
- Id string
The provider-assigned unique ID for this managed resource.
- Is
Parent bool Whether to include subtasks.
- Outputs string
The outputs of OOS Execution.
- Ram
Role string The role that executes the current template.
- Start
Date string The time when the execution was started.
- Status string
The status of OOS Execution.
- Status
Message string The message of status.
- Template
Id string The id of template.
- Update
Date string The time when the execution was updated.
- Counters string
The counters of OOS Execution.
- Create
Date string The time when the execution was created.
- End
Date string The time when the execution was ended.
- Executed
By string The user who execute the template.
- Id string
The provider-assigned unique ID for this managed resource.
- Is
Parent bool Whether to include subtasks.
- Outputs string
The outputs of OOS Execution.
- Ram
Role string The role that executes the current template.
- Start
Date string The time when the execution was started.
- Status string
The status of OOS Execution.
- Status
Message string The message of status.
- Template
Id string The id of template.
- Update
Date string The time when the execution was updated.
- counters String
The counters of OOS Execution.
- create
Date String The time when the execution was created.
- end
Date String The time when the execution was ended.
- executed
By String The user who execute the template.
- id String
The provider-assigned unique ID for this managed resource.
- is
Parent Boolean Whether to include subtasks.
- outputs String
The outputs of OOS Execution.
- ram
Role String The role that executes the current template.
- start
Date String The time when the execution was started.
- status String
The status of OOS Execution.
- status
Message String The message of status.
- template
Id String The id of template.
- update
Date String The time when the execution was updated.
- counters string
The counters of OOS Execution.
- create
Date string The time when the execution was created.
- end
Date string The time when the execution was ended.
- executed
By string The user who execute the template.
- id string
The provider-assigned unique ID for this managed resource.
- is
Parent boolean Whether to include subtasks.
- outputs string
The outputs of OOS Execution.
- ram
Role string The role that executes the current template.
- start
Date string The time when the execution was started.
- status string
The status of OOS Execution.
- status
Message string The message of status.
- template
Id string The id of template.
- update
Date string The time when the execution was updated.
- counters str
The counters of OOS Execution.
- create_
date str The time when the execution was created.
- end_
date str The time when the execution was ended.
- executed_
by str The user who execute the template.
- id str
The provider-assigned unique ID for this managed resource.
- is_
parent bool Whether to include subtasks.
- outputs str
The outputs of OOS Execution.
- ram_
role str The role that executes the current template.
- start_
date str The time when the execution was started.
- status str
The status of OOS Execution.
- status_
message str The message of status.
- template_
id str The id of template.
- update_
date str The time when the execution was updated.
- counters String
The counters of OOS Execution.
- create
Date String The time when the execution was created.
- end
Date String The time when the execution was ended.
- executed
By String The user who execute the template.
- id String
The provider-assigned unique ID for this managed resource.
- is
Parent Boolean Whether to include subtasks.
- outputs String
The outputs of OOS Execution.
- ram
Role String The role that executes the current template.
- start
Date String The time when the execution was started.
- status String
The status of OOS Execution.
- status
Message String The message of status.
- template
Id String The id of template.
- update
Date String The time when the execution was updated.
Look up Existing Execution Resource
Get an existing Execution 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?: ExecutionState, opts?: CustomResourceOptions): Execution@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
counters: Optional[str] = None,
create_date: Optional[str] = None,
description: Optional[str] = None,
end_date: Optional[str] = None,
executed_by: Optional[str] = None,
is_parent: Optional[bool] = None,
loop_mode: Optional[str] = None,
mode: Optional[str] = None,
outputs: Optional[str] = None,
parameters: Optional[str] = None,
parent_execution_id: Optional[str] = None,
ram_role: Optional[str] = None,
safety_check: Optional[str] = None,
start_date: Optional[str] = None,
status: Optional[str] = None,
status_message: Optional[str] = None,
template_content: Optional[str] = None,
template_id: Optional[str] = None,
template_name: Optional[str] = None,
template_version: Optional[str] = None,
update_date: Optional[str] = None) -> Executionfunc GetExecution(ctx *Context, name string, id IDInput, state *ExecutionState, opts ...ResourceOption) (*Execution, error)public static Execution Get(string name, Input<string> id, ExecutionState? state, CustomResourceOptions? opts = null)public static Execution get(String name, Output<String> id, ExecutionState state, CustomResourceOptions options)Resource lookup is not supported in YAML- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Counters string
The counters of OOS Execution.
- Create
Date string The time when the execution was created.
- Description string
The description of OOS Execution.
- End
Date string The time when the execution was ended.
- Executed
By string The user who execute the template.
- Is
Parent bool Whether to include subtasks.
- Loop
Mode string The loop mode of OOS Execution.
- Mode string
The mode of OOS Execution. Valid:
Automatic,Debug. Default toAutomatic.- Outputs string
The outputs of OOS Execution.
- Parameters string
The parameters required by the template. Default to
{}.- Parent
Execution stringId The id of parent execution.
- Ram
Role string The role that executes the current template.
- Safety
Check string The mode of safety check.
- Start
Date string The time when the execution was started.
- Status string
The status of OOS Execution.
- Status
Message string The message of status.
- Template
Content string The content of template. When the user selects an existing template to create and execute a task, it is not necessary to pass in this field.
- Template
Id string The id of template.
- Template
Name string The name of execution template.
- Template
Version string The version of execution template.
- Update
Date string The time when the execution was updated.
- Counters string
The counters of OOS Execution.
- Create
Date string The time when the execution was created.
- Description string
The description of OOS Execution.
- End
Date string The time when the execution was ended.
- Executed
By string The user who execute the template.
- Is
Parent bool Whether to include subtasks.
- Loop
Mode string The loop mode of OOS Execution.
- Mode string
The mode of OOS Execution. Valid:
Automatic,Debug. Default toAutomatic.- Outputs string
The outputs of OOS Execution.
- Parameters string
The parameters required by the template. Default to
{}.- Parent
Execution stringId The id of parent execution.
- Ram
Role string The role that executes the current template.
- Safety
Check string The mode of safety check.
- Start
Date string The time when the execution was started.
- Status string
The status of OOS Execution.
- Status
Message string The message of status.
- Template
Content string The content of template. When the user selects an existing template to create and execute a task, it is not necessary to pass in this field.
- Template
Id string The id of template.
- Template
Name string The name of execution template.
- Template
Version string The version of execution template.
- Update
Date string The time when the execution was updated.
- counters String
The counters of OOS Execution.
- create
Date String The time when the execution was created.
- description String
The description of OOS Execution.
- end
Date String The time when the execution was ended.
- executed
By String The user who execute the template.
- is
Parent Boolean Whether to include subtasks.
- loop
Mode String The loop mode of OOS Execution.
- mode String
The mode of OOS Execution. Valid:
Automatic,Debug. Default toAutomatic.- outputs String
The outputs of OOS Execution.
- parameters String
The parameters required by the template. Default to
{}.- parent
Execution StringId The id of parent execution.
- ram
Role String The role that executes the current template.
- safety
Check String The mode of safety check.
- start
Date String The time when the execution was started.
- status String
The status of OOS Execution.
- status
Message String The message of status.
- template
Content String The content of template. When the user selects an existing template to create and execute a task, it is not necessary to pass in this field.
- template
Id String The id of template.
- template
Name String The name of execution template.
- template
Version String The version of execution template.
- update
Date String The time when the execution was updated.
- counters string
The counters of OOS Execution.
- create
Date string The time when the execution was created.
- description string
The description of OOS Execution.
- end
Date string The time when the execution was ended.
- executed
By string The user who execute the template.
- is
Parent boolean Whether to include subtasks.
- loop
Mode string The loop mode of OOS Execution.
- mode string
The mode of OOS Execution. Valid:
Automatic,Debug. Default toAutomatic.- outputs string
The outputs of OOS Execution.
- parameters string
The parameters required by the template. Default to
{}.- parent
Execution stringId The id of parent execution.
- ram
Role string The role that executes the current template.
- safety
Check string The mode of safety check.
- start
Date string The time when the execution was started.
- status string
The status of OOS Execution.
- status
Message string The message of status.
- template
Content string The content of template. When the user selects an existing template to create and execute a task, it is not necessary to pass in this field.
- template
Id string The id of template.
- template
Name string The name of execution template.
- template
Version string The version of execution template.
- update
Date string The time when the execution was updated.
- counters str
The counters of OOS Execution.
- create_
date str The time when the execution was created.
- description str
The description of OOS Execution.
- end_
date str The time when the execution was ended.
- executed_
by str The user who execute the template.
- is_
parent bool Whether to include subtasks.
- loop_
mode str The loop mode of OOS Execution.
- mode str
The mode of OOS Execution. Valid:
Automatic,Debug. Default toAutomatic.- outputs str
The outputs of OOS Execution.
- parameters str
The parameters required by the template. Default to
{}.- parent_
execution_ strid The id of parent execution.
- ram_
role str The role that executes the current template.
- safety_
check str The mode of safety check.
- start_
date str The time when the execution was started.
- status str
The status of OOS Execution.
- status_
message str The message of status.
- template_
content str The content of template. When the user selects an existing template to create and execute a task, it is not necessary to pass in this field.
- template_
id str The id of template.
- template_
name str The name of execution template.
- template_
version str The version of execution template.
- update_
date str The time when the execution was updated.
- counters String
The counters of OOS Execution.
- create
Date String The time when the execution was created.
- description String
The description of OOS Execution.
- end
Date String The time when the execution was ended.
- executed
By String The user who execute the template.
- is
Parent Boolean Whether to include subtasks.
- loop
Mode String The loop mode of OOS Execution.
- mode String
The mode of OOS Execution. Valid:
Automatic,Debug. Default toAutomatic.- outputs String
The outputs of OOS Execution.
- parameters String
The parameters required by the template. Default to
{}.- parent
Execution StringId The id of parent execution.
- ram
Role String The role that executes the current template.
- safety
Check String The mode of safety check.
- start
Date String The time when the execution was started.
- status String
The status of OOS Execution.
- status
Message String The message of status.
- template
Content String The content of template. When the user selects an existing template to create and execute a task, it is not necessary to pass in this field.
- template
Id String The id of template.
- template
Name String The name of execution template.
- template
Version String The version of execution template.
- update
Date String The time when the execution was updated.
Import
OOS Execution can be imported using the id, e.g.
$ pulumi import alicloud:oos/execution:Execution example exec-ef6xxxx
Package Details
- Repository
- Alibaba Cloud pulumi/pulumi-alicloud
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
alicloudTerraform Provider.