pub struct SignalResourceFluentBuilder { /* private fields */ }Expand description
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§
Source§impl SignalResourceFluentBuilder
impl SignalResourceFluentBuilder
Sourcepub fn as_input(&self) -> &SignalResourceInputBuilder
pub fn as_input(&self) -> &SignalResourceInputBuilder
Access the SignalResource as a reference.
Sourcepub async fn send(
self,
) -> Result<SignalResourceOutput, SdkError<SignalResourceError, HttpResponse>>
pub async fn send( self, ) -> Result<SignalResourceOutput, SdkError<SignalResourceError, HttpResponse>>
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.
Sourcepub fn customize(
self,
) -> CustomizableOperation<SignalResourceOutput, SignalResourceError, Self>
pub fn customize( self, ) -> CustomizableOperation<SignalResourceOutput, SignalResourceError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn stack_name(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_stack_name(self, input: Option<String>) -> Self
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.
Sourcepub fn get_stack_name(&self) -> &Option<String>
pub fn get_stack_name(&self) -> &Option<String>
The stack name or unique stack ID that includes the resource that you want to signal.
Sourcepub fn logical_resource_id(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_logical_resource_id(self, input: Option<String>) -> Self
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.
Sourcepub fn get_logical_resource_id(&self) -> &Option<String>
pub fn get_logical_resource_id(&self) -> &Option<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.
Sourcepub fn unique_id(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_unique_id(self, input: Option<String>) -> Self
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.
Sourcepub fn get_unique_id(&self) -> &Option<String>
pub fn get_unique_id(&self) -> &Option<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.
Sourcepub fn status(self, input: ResourceSignalStatus) -> Self
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.
Sourcepub fn set_status(self, input: Option<ResourceSignalStatus>) -> Self
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.
Sourcepub fn get_status(&self) -> &Option<ResourceSignalStatus>
pub fn get_status(&self) -> &Option<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.
Trait Implementations§
Source§impl Clone for SignalResourceFluentBuilder
impl Clone for SignalResourceFluentBuilder
Source§fn clone(&self) -> SignalResourceFluentBuilder
fn clone(&self) -> SignalResourceFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for SignalResourceFluentBuilder
impl !RefUnwindSafe for SignalResourceFluentBuilder
impl Send for SignalResourceFluentBuilder
impl Sync for SignalResourceFluentBuilder
impl Unpin for SignalResourceFluentBuilder
impl !UnwindSafe for SignalResourceFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);