| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.CloudFormation.SignalResource
Description
Sends a signal to the specified resource with a success or failure status. You can use the SignalResource API 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 API is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.
Synopsis
- data SignalResource = SignalResource' {}
- newSignalResource :: Text -> Text -> Text -> ResourceSignalStatus -> SignalResource
- signalResource_stackName :: Lens' SignalResource Text
- signalResource_logicalResourceId :: Lens' SignalResource Text
- signalResource_uniqueId :: Lens' SignalResource Text
- signalResource_status :: Lens' SignalResource ResourceSignalStatus
- data SignalResourceResponse = SignalResourceResponse' {
- newSignalResourceResponse :: SignalResourceResponse
Creating a Request
data SignalResource Source #
The input for the SignalResource action.
See: newSignalResource smart constructor.
Constructors
| SignalResource' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> ResourceSignalStatus | |
| -> SignalResource |
Create a value of SignalResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:stackName:SignalResource', signalResource_stackName - The stack name or unique stack ID that includes the resource that you
want to signal.
$sel:logicalResourceId:SignalResource', signalResource_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.
$sel:uniqueId:SignalResource', signalResource_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.
$sel:status:SignalResource', signalResource_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.
Request Lenses
signalResource_stackName :: Lens' SignalResource Text Source #
The stack name or unique stack ID that includes the resource that you want to signal.
signalResource_logicalResourceId :: Lens' SignalResource Text Source #
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.
signalResource_uniqueId :: Lens' SignalResource Text Source #
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.
signalResource_status :: Lens' SignalResource ResourceSignalStatus Source #
The status of the signal, which is either success or failure. A failure signal causes CloudFormation to immediately fail the stack creation or update.
Destructuring the Response
data SignalResourceResponse Source #
See: newSignalResourceResponse smart constructor.
Constructors
| SignalResourceResponse' | |
Instances
newSignalResourceResponse :: SignalResourceResponse Source #
Create a value of SignalResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.