ALIYUN::OOS::Execution is used to start an execution.
Syntax
{
"Type": "ALIYUN::OOS::Execution",
"Properties": {
"ResourceOptions": Map,
"Parameters": Map,
"Tags": Map,
"TemplateName": String,
"ParentExecutionId": String,
"SafetyCheck": String,
"Mode": String,
"TemplateVersion": String,
"ResourceGroupId": String
}
}
Properties
Property | Type | Required | Editable | Description | Constraint |
ResourceOptions | Map | No | No | The resource options that are used by Resource Orchestration Service (ROS). | For more information, see ResourceOptions properties. |
Parameters | Map | No | No | The JSON strings that consist of parameters. | Example: Default value: {}. |
Tags | Map | No | No | The tags. A tag is a key-value pair. Example: {"k1":"v1", "k2":"v2"}. | You can add up to 20 tags. |
TemplateName | String | Yes | No | The name of the template. | The name can be up to 200 characters in length. The name cannot start with ALIYUN, ACS, or ALIBABA. The name can contain letters, digits, hyphens (-), and underscores (_). |
ParentExecutionId | String | No | No | The ID of the parent execution. | None. |
SafetyCheck | String | No | No | The safety check mode. | Valid values:
|
Mode | String | No | No | The execution mode. | Valid values:
|
TemplateVersion | String | No | No | The version number. | If you do not specify this property, the system uses the latest version. |
ResourceGroupId | String | No | No | The ID of the resource group. | None. |
ResourceOptions syntax
"ResourceOptions": {
"SuccessStatuses": List,
"Timeout": Number,
"CancelOnDelete": Boolean,
"FailureStatuses": List
}
ResourceOptions properties
Property | Type | Required | Editable | Description | Constraint |
SuccessStatuses | List | No | No | The states that indicate whether resources are created. | Valid values:
If the state of the execution is included in the value of the FailureStatuses property, resources failed to be created. If the state of the execution is included in the value of the SuccessStatuses property, resources are created. If neither of the preceding conditions is met, the system waits until the request times out. |
Timeout | Number | No | No | The timeout period. | Unit: seconds. Default value: 1800. |
CancelOnDelete | Boolean | No | No | Indicates whether to cancel the execution that is not completed when the resource is being deleted. | Valid values:
|
FailureStatuses | List | No | No | The states that indicate whether resources failed to be created. The FailureStatuses property takes precedence over the SuccessStatuses property. | Valid values:
Default value: |
Return values
Fn::GetAtt
Status: the state of the execution.
WindowsCurlCli: The cURL CLI command prefix that is provided for Windows. WindowsCurlCli can be used to send a signal that indicates whether the execution is completed or failed. For more information, see NotifyExecution.
PowerShellCurlCli: The cURL CLI command prefix that is provided for PowerShell. PowerShellCurlCli can be used to send a signal that indicates whether the execution is completed or failed.
Outputs: the outputs of the execution.
ExecutionId: the unique ID of the execution.
CurlCli: the cURL command.
StatusMessage: the status information.
Counters: the number of executions.