You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CloudFormation::Types::SignalResourceInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing SignalResourceInput as input to an Aws::Client method, you can use a vanilla 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

Instance Attribute Details

#logical_resource_idString

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.

Returns:

  • (String)

    The logical ID of the resource that you want to signal.

#stack_nameString

The stack name or unique stack ID that includes the resource that you want to signal.

Returns:

  • (String)

    The stack name or unique stack ID that includes the resource that you want to signal.

#statusString

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.

Possible values:

  • SUCCESS
  • FAILURE

Returns:

  • (String)

    The status of the signal, which is either success or failure.

#unique_idString

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.

Returns:

  • (String)

    A unique ID of the signal.