Class: Aws::CloudFormation::Types::SignalResourceInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::CloudFormation::Types::SignalResourceInput
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-cloudformation/types.rb
Overview
When making an API call, you may pass SignalResourceInput data as a hash:
{
stack_name: "StackNameOrId", # required
logical_resource_id: "LogicalResourceId", # required
unique_id: "ResourceSignalUniqueId", # required
status: "SUCCESS", # required, accepts SUCCESS, FAILURE
}
The input for the SignalResource action.
Instance Attribute Summary collapse
-
#logical_resource_id ⇒ String
The logical ID of the resource that you want to signal.
-
#stack_name ⇒ String
The stack name or unique stack ID that includes the resource that you want to signal.
-
#status ⇒ String
The status of the signal, which is either success or failure.
-
#unique_id ⇒ String
A unique ID of the signal.
Instance Attribute Details
#logical_resource_id ⇒ String
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.
3826 3827 3828 3829 3830 3831 3832 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 3826 class SignalResourceInput < Struct.new( :stack_name, :logical_resource_id, :unique_id, :status) include Aws::Structure end |
#stack_name ⇒ String
The stack name or unique stack ID that includes the resource that you want to signal.
3826 3827 3828 3829 3830 3831 3832 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 3826 class SignalResourceInput < Struct.new( :stack_name, :logical_resource_id, :unique_id, :status) include Aws::Structure end |
#status ⇒ String
The status of the signal, which is either success or failure. A failure signal causes AWS CloudFormation to immediately fail the stack creation or update.
3826 3827 3828 3829 3830 3831 3832 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 3826 class SignalResourceInput < Struct.new( :stack_name, :logical_resource_id, :unique_id, :status) include Aws::Structure end |
#unique_id ⇒ String
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.
3826 3827 3828 3829 3830 3831 3832 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 3826 class SignalResourceInput < Struct.new( :stack_name, :logical_resource_id, :unique_id, :status) include Aws::Structure end |