signal_resource¶
Operation¶
signal_resource
¶
signal_resource(request: SignalResourceInput | SignalResourceInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[SignalResourceInputDict]) -> SignalResourceOutput
Sends a signal to the specified resource with a success or failure
status. You can use the SignalResource operation in conjunction with a
creation policy or update policy. CloudFormation doesn't proceed with a
stack creation or update until resources receive the required number of
signals or the timeout period is exceeded. The SignalResource
operation is useful in cases where you want to send signals from
anywhere other than an Amazon EC2 instance.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
SignalResourceInput | SignalResourceInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[SignalResourceInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
SignalResourceOutput
|
An instance of |
signal_resource
async
¶
signal_resource(request: SignalResourceInput | SignalResourceInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[SignalResourceInputDict]) -> SignalResourceOutput
Sends a signal to the specified resource with a success or failure
status. You can use the SignalResource operation in conjunction with a
creation policy or update policy. CloudFormation doesn't proceed with a
stack creation or update until resources receive the required number of
signals or the timeout period is exceeded. The SignalResource
operation is useful in cases where you want to send signals from
anywhere other than an Amazon EC2 instance.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
SignalResourceInput | SignalResourceInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[SignalResourceInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
SignalResourceOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
SignalResourceInputDict
¶
Bases: TypedDict
Dictionary form of SignalResourceInput.
Attributes¶
logical_resource_id
instance-attribute
¶
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
¶
The stack name or unique stack ID that includes the resource that you want to signal.
status
instance-attribute
¶
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
¶
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.
SignalResourceInput
dataclass
¶
Bases: _SerdeShape
The input for the SignalResource action.
Attributes¶
logical_resource_id
class-attribute
instance-attribute
¶
logical_resource_id: str | None = ...
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
class-attribute
instance-attribute
¶
stack_name: str | None = ...
The stack name or unique stack ID that includes the resource that you want to signal.
status
class-attribute
instance-attribute
¶
status: str | None = ...
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
class-attribute
instance-attribute
¶
unique_id: str | None = ...
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.
Output¶
SignalResourceOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for SignalResourceOutput structure.