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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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.

Returns:

  • (String) 

6664
6665
6666
6667
6668
6669
6670
6671
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 6664

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

#stack_name ⇒ String

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

Returns:

  • (String) 

6664
6665
6666
6667
6668
6669
6670
6671
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 6664

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

#status ⇒ String

The status of the signal, which is either success or failure. A failure signal causes CloudFormation to immediately fail the stack creation or update.

Returns:

  • (String) 

6664
6665
6666
6667
6668
6669
6670
6671
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 6664

class SignalResourceInput < Struct.new(
  :stack_name,
  :logical_resource_id,
  :unique_id,
  :status)
  SENSITIVE = []
  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.

Returns:

  • (String) 

6664
6665
6666
6667
6668
6669
6670
6671
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 6664

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