Struct aws_sdk_cloudformation::client::fluent_builders::SignalResource

pub struct SignalResource { /* private fields */ }

Fluent builder constructing a request to SignalResource.

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.

Implementations

impl SignalResource

pub async fn customize(
    self
) -> Result<CustomizableOperation<SignalResource, AwsResponseRetryClassifier>, SdkError<SignalResourceError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<SignalResourceOutput, SdkError<SignalResourceError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn stack_name(self, input: impl Into<String>) -> Self

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

pub fn set_stack_name(self, input: Option<String>) -> Self

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

pub fn logical_resource_id(self, input: impl Into<String>) -> Self

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.

pub fn set_logical_resource_id(self, input: Option<String>) -> Self

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.

pub fn unique_id(self, input: impl Into<String>) -> Self

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.

pub fn set_unique_id(self, input: Option<String>) -> Self

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.

pub fn status(self, input: ResourceSignalStatus) -> Self

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

pub fn set_status(self, input: Option<ResourceSignalStatus>) -> Self

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

Trait Implementations

impl Clone for SignalResource

fn clone(&self) -> SignalResource

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SignalResource

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.