Skip to content

ExecutionProps

Properties for defining a Execution.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-oos-execution

Initializer 

import { ExecutionProps } from '@alicloud/ros-cdk-oos'
const executionProps: ExecutionProps = { ... }

Properties

Name Type Description
description string | @alicloud/ros-cdk-core.IResolvable Property description: The description of OOS Execution.
loopMode string | @alicloud/ros-cdk-core.IResolvable Property loopMode: The loop mode of OOS Execution.
mode string | @alicloud/ros-cdk-core.IResolvable Property mode: Execution mode.
parameters @alicloud/ros-cdk-core.IResolvable | {[ key: string ]: any} Property parameters: Parameters for the execution of template.
parentExecutionId string | @alicloud/ros-cdk-core.IResolvable Property parentExecutionId: Parent execution ID.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: Resource group id.
resourceOptions @alicloud/ros-cdk-core.IResolvable | ResourceOptionsProperty Property resourceOptions: Resource options user by ROS.
safetyCheck string | @alicloud/ros-cdk-core.IResolvable Property safetyCheck: Security check mode.
tags {[ key: string ]: any} Property tags: Tag value and the key mapping, the label of the key number can be up to 20.
templateContent string | @alicloud/ros-cdk-core.IResolvable Property templateContent: The content of the template in the JSON or YAML format.
templateName string | @alicloud/ros-cdk-core.IResolvable Property templateName: Template name.
templateUrl string | @alicloud/ros-cdk-core.IResolvable Property templateUrl: The Object Storage Service (OSS) URL of the object that stores the content of the Operation Orchestration Service (OOS) template.
templateVersion string | @alicloud/ros-cdk-core.IResolvable Property templateVersion: Version number of template.

descriptionOptional 

public readonly description: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property description: The description of OOS Execution.

loopModeOptional 

public readonly loopMode: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property loopMode: The loop mode of OOS Execution.

Valid values: - Automatic(Default): does not pause. - FirstBatchPause: The first batch of pauses. - EveryBatchPause: pause each batch.

modeOptional 

public readonly mode: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property mode: Execution mode.

parametersOptional 

public readonly parameters: IResolvable | {[ key: string ]: any};
  • Type: @alicloud/ros-cdk-core.IResolvable | {[ key: string ]: any}

Property parameters: Parameters for the execution of template.

parentExecutionIdOptional 

public readonly parentExecutionId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property parentExecutionId: Parent execution ID.

resourceGroupIdOptional 

public readonly resourceGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property resourceGroupId: Resource group id.

resourceOptionsOptional 

public readonly resourceOptions: IResolvable | ResourceOptionsProperty;

Property resourceOptions: Resource options user by ROS.

safetyCheckOptional 

public readonly safetyCheck: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property safetyCheck: Security check mode.

Allowed values: - Skip: This option means that customers understand the risks, you can do anything without confirmation Action, no matter what the level of risk. It takes effect only if Mode is Automatic. - ConfirmEveryHighRiskAction (default): This option would require customers to confirm each Action a high risk. NotifyExecution by calling customer interface to confirm or cancel.

tagsOptional 

public readonly tags: {[ key: string ]: any};
  • Type: {[ key: string ]: any}

Property tags: Tag value and the key mapping, the label of the key number can be up to 20.

templateContentOptional 

public readonly templateContent: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property templateContent: The content of the template in the JSON or YAML format.

This parameter is the same as the Content parameter that you can specify when you call the CreateTemplate operation. You can use this parameter to specify the tasks that you want to run. This way, you do not need to create a template before you start an execution. If you select an existing template, you do not need to specify this parameter.

templateNameOptional 

public readonly templateName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property templateName: Template name.

Content is limited to letters, numbers, underlined, underline, the length of 200 characters.

templateUrlOptional 

public readonly templateUrl: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property templateUrl: The Object Storage Service (OSS) URL of the object that stores the content of the Operation Orchestration Service (OOS) template.

The access control list (ACL) of the object must be public-read. You can use this parameter to specify the tasks that you want to run. This way, you do not need to create a template before you start an execution. If you select an existing template, you do not need to specify this parameter.

templateVersionOptional 

public readonly templateVersion: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property templateVersion: Version number of template.

Default to the latest version.