Skip to content

SignalResourceInput

Source code in docs_src/capo_cloudformation/types/signal_resource_input.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class SignalResourceInput(TypedDict, closed=True):
    stack_name: NotRequired["capo_cloudformation.types.stack_name_or_id.StackNameOrId"]
    """<p>The stack name or unique stack ID that includes the resource that you want to signal.</p>"""
    logical_resource_id: NotRequired[
        "capo_cloudformation.types.logical_resource_id.LogicalResourceId"
    ]
    """<p>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.</p>"""
    unique_id: NotRequired[
        "capo_cloudformation.types.resource_signal_unique_id.ResourceSignalUniqueId"
    ]
    """<p>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.</p>"""
    status: NotRequired[
        "capo_cloudformation.types.resource_signal_status.ResourceSignalStatus"
    ]
    """<p>The status of the signal, which is either success or failure. A failure signal causes CloudFormation to immediately fail the stack creation or update.</p>"""

logical_resource_id instance-attribute 

logical_resource_id: NotRequired[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.

stack_name instance-attribute 

stack_name: NotRequired[StackNameOrId]

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

status instance-attribute 

status: NotRequired[ResourceSignalStatus]

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

unique_id instance-attribute 

unique_id: NotRequired[ResourceSignalUniqueId]

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.