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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb

Overview

Note:

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

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)


3342
3343
3344
3345
3346
3347
3348
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3342

class SignalResourceInput < Struct.new(
  :stack_name,
  :logical_resource_id,
  :unique_id,
  :status)
  include Aws::Structure
end

#stack_nameString

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

Returns:

  • (String)


3342
3343
3344
3345
3346
3347
3348
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3342

class SignalResourceInput < Struct.new(
  :stack_name,
  :logical_resource_id,
  :unique_id,
  :status)
  include Aws::Structure
end

#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.

Returns:

  • (String)


3342
3343
3344
3345
3346
3347
3348
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3342

class SignalResourceInput < Struct.new(
  :stack_name,
  :logical_resource_id,
  :unique_id,
  :status)
  include Aws::Structure
end

#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)


3342
3343
3344
3345
3346
3347
3348
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3342

class SignalResourceInput < Struct.new(
  :stack_name,
  :logical_resource_id,
  :unique_id,
  :status)
  include Aws::Structure
end