Container for the parameters to the SignalResource operation.
Sends a signal to the specified resource with a success or failure status. You can
use the SignalResource operation in conjunction with a creation policy or update
policy. CloudFormation doesn't proceed with a stack creation or update until resources
receive the required number of signals or the timeout period is exceeded. The SignalResource
operation is useful in cases where you want to send signals from anywhere other than
an Amazon EC2 instance.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.CloudFormation.AmazonCloudFormationRequest
Amazon.CloudFormation.Model.SignalResourceRequest
Namespace: Amazon.CloudFormation.Model
Assembly: AWSSDK.CloudFormation.dll
Version: 3.x.y.z
Syntax
public class SignalResourceRequest : AmazonCloudFormationRequest IAmazonWebServiceRequest
The SignalResourceRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
SignalResourceRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
LogicalResourceId | System.String |
Gets and sets the property LogicalResourceId. The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in the template. |
|
|
StackName | System.String |
Gets and sets the property StackName. The stack name or unique stack ID that includes the resource that you want to signal. |
|
|
Status | Amazon.CloudFormation.ResourceSignalStatus |
Gets and sets the property Status. The status of the signal, which is either success or failure. A failure signal causes CloudFormation to immediately fail the stack creation or update. |
|
|
UniqueId | System.String |
Gets and sets the property UniqueId. A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as signaling a wait condition), each signal requires a different unique ID. |
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5