WaitConditionHandle
This class encapsulates and extends the ROS resource type ALIYUN::ROS::WaitConditionHandle, which is used to receive signals.
You can use ALIYUN::ROS::WaitConditionHandle together with ALIYUN::ROS::WaitCondition to manage the execution process of a stack. When you create an Elastic Compute Service (ECS) instance, a signal is sent during the execution of the user data.
Initializers
import { WaitConditionHandle } from '@alicloud/ros-cdk-ros'
new WaitConditionHandle(scope: Construct, id: string, props?: WaitConditionHandleProps, enableResourcePropertyConstraint?: boolean)
| Name | Type | Description |
|---|---|---|
scope |
@alicloud/ros-cdk-core.Construct |
No description. |
id |
string |
No description. |
props |
WaitConditionHandleProps |
No description. |
enableResourcePropertyConstraint |
boolean |
No description. |
scopeRequired
- Type: @alicloud/ros-cdk-core.Construct
idRequired
- Type: string
propsOptional
- Type: WaitConditionHandleProps
enableResourcePropertyConstraintOptional
- Type: boolean
Methods
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
synthesize |
Allows this construct to emit artifacts into the cloud assembly during synthesis. |
addCondition |
No description. |
addCount |
No description. |
addDependency |
No description. |
addResourceDesc |
No description. |
applyRemovalPolicy |
No description. |
getAtt |
No description. |
setMetadata |
No description. |
toString
public toString(): string
Returns a string representation of this construct.
synthesize
public synthesize(session: ISynthesisSession): void
Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as Stack and Asset
as they participate in synthesizing the cloud assembly.
- Type: @alicloud/ros-cdk-core.ISynthesisSession
The synthesis session.
addCondition
public addCondition(condition: RosCondition): void
- Type: @alicloud/ros-cdk-core.RosCondition
addCount
public addCount(count: number | IResolvable): void
- Type: number | @alicloud/ros-cdk-core.IResolvable
addDependency
public addDependency(resource: Resource): void
- Type: @alicloud/ros-cdk-core.Resource
addResourceDesc
public addResourceDesc(desc: string): void
- Type: string
applyRemovalPolicy
public applyRemovalPolicy(policy: RemovalPolicy): void
- Type: @alicloud/ros-cdk-core.RemovalPolicy
getAtt
public getAtt(name: string): IResolvable
- Type: string
setMetadata
public setMetadata(key: string, value: any): void
- Type: string
- Type: any
Static Functions
| Name | Description |
|---|---|
isConstruct |
Return whether the given object is a Construct. |
isConstruct
import { WaitConditionHandle } from '@alicloud/ros-cdk-ros'
WaitConditionHandle.isConstruct(x: any)
Return whether the given object is a Construct.
- Type: any
Properties
| Name | Type | Description |
|---|---|---|
node |
@alicloud/ros-cdk-core.ConstructNode |
The construct tree node associated with this construct. |
ref |
string |
No description. |
stack |
@alicloud/ros-cdk-core.Stack |
The stack in which this resource is defined. |
resource |
@alicloud/ros-cdk-core.RosResource |
No description. |
attrCurlCli |
@alicloud/ros-cdk-core.IResolvable |
Attribute CurlCli: Convenience attribute, provides curl CLI command prefix, which can be used for signalling handle completion or failure. |
attrHeaders |
@alicloud/ros-cdk-core.IResolvable |
Attribute Headers: HTTP POST Headers used for signalling handle completion or failure. |
attrPowerShellCurlCli |
@alicloud/ros-cdk-core.IResolvable |
Attribute PowerShellCurlCli: Convenience attribute, provides curl CLI command prefix for PowerShell, which can be used for signalling handle completion or failure. |
attrUrl |
@alicloud/ros-cdk-core.IResolvable |
Attribute URL: HTTP POST URL used for signalling handle completion or failure. |
attrWindowsCurlCli |
@alicloud/ros-cdk-core.IResolvable |
Attribute WindowsCurlCli: Convenience attribute, provides curl CLI command prefix for Windows, which can be used for signalling handle completion or failure. |
nodeRequired
public readonly node: ConstructNode;
- Type: @alicloud/ros-cdk-core.ConstructNode
The construct tree node associated with this construct.
refRequired
public readonly ref: string;
- Type: string
stackRequired
public readonly stack: Stack;
- Type: @alicloud/ros-cdk-core.Stack
The stack in which this resource is defined.
resourceOptional
public readonly resource: RosResource;
- Type: @alicloud/ros-cdk-core.RosResource
attrCurlCliRequired
public readonly attrCurlCli: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
Attribute CurlCli: Convenience attribute, provides curl CLI command prefix, which can be used for signalling handle completion or failure.
You can signal success by adding --data-binary '{"status": "SUCCESS"}' , or signal failure by adding --data-binary '{"status": "FAILURE"}'
attrHeadersRequired
public readonly attrHeaders: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
Attribute Headers: HTTP POST Headers used for signalling handle completion or failure.
attrPowerShellCurlCliRequired
public readonly attrPowerShellCurlCli: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
Attribute PowerShellCurlCli: Convenience attribute, provides curl CLI command prefix for PowerShell, which can be used for signalling handle completion or failure.
As this cmdlet was introduced in PowerShell 3.0, ensure the version of PowerShell satisfies the constraint. (Show the version via $PSVersionTable.PSVersion.) You can signal success by adding -Body '{"status": "SUCCESS"}' , or signal failure by adding -Body '{"status": "FAILURE"}'
attrUrlRequired
public readonly attrUrl: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
Attribute URL: HTTP POST URL used for signalling handle completion or failure.
attrWindowsCurlCliRequired
public readonly attrWindowsCurlCli: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
Attribute WindowsCurlCli: Convenience attribute, provides curl CLI command prefix for Windows, which can be used for signalling handle completion or failure.
As Windows does not support curl command, you need to install curl.exe and add it to PATH first. You can signal success by adding --data-binary "{\"status\": \"SUCCESS\"}" , or signal failure by adding --data-binary "{\"status\": \"FAILURE\"}"