pub struct UpdateStateMachineFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to UpdateStateMachine.
Updates an existing state machine by modifying its definition, roleArn, loggingConfiguration, or EncryptionConfiguration. Running executions will continue to use the previous definition and roleArn. You must include at least one of definition or roleArn or you will receive a MissingRequiredParameter error.
A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName.
A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.
The following are some examples of qualified and unqualified state machine ARNs:
-
The following qualified state machine ARN refers to a Distributed Map state with a label
mapStateLabelin a state machine namedmyStateMachine.arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabelIf you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with
ValidationException. -
The following qualified state machine ARN refers to an alias named
PROD.arn::states: : :stateMachine: If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias.
-
The following unqualified state machine ARN refers to a state machine named
myStateMachine.arn::states: : :stateMachine:
After you update your state machine, you can set the publish parameter to true in the same action to publish a new version. This way, you can opt-in to strict versioning of your state machine.
Step Functions assigns monotonically increasing integers for state machine versions, starting at version number 1.
All StartExecution calls within a few seconds use the updated definition and roleArn. Executions started immediately after you call UpdateStateMachine may use the previous state machine definition and roleArn.
Implementations§
Source§impl UpdateStateMachineFluentBuilder
impl UpdateStateMachineFluentBuilder
Sourcepub fn as_input(&self) -> &UpdateStateMachineInputBuilder
pub fn as_input(&self) -> &UpdateStateMachineInputBuilder
Access the UpdateStateMachine as a reference.
Sourcepub async fn send(
self,
) -> Result<UpdateStateMachineOutput, SdkError<UpdateStateMachineError, HttpResponse>>
pub async fn send( self, ) -> Result<UpdateStateMachineOutput, SdkError<UpdateStateMachineError, 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<UpdateStateMachineOutput, UpdateStateMachineError, Self>
pub fn customize( self, ) -> CustomizableOperation<UpdateStateMachineOutput, UpdateStateMachineError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn state_machine_arn(self, input: impl Into<String>) -> Self
pub fn state_machine_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the state machine.
Sourcepub fn set_state_machine_arn(self, input: Option<String>) -> Self
pub fn set_state_machine_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the state machine.
Sourcepub fn get_state_machine_arn(&self) -> &Option<String>
pub fn get_state_machine_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the state machine.
Sourcepub fn definition(self, input: impl Into<String>) -> Self
pub fn definition(self, input: impl Into<String>) -> Self
The Amazon States Language definition of the state machine. See Amazon States Language.
Sourcepub fn set_definition(self, input: Option<String>) -> Self
pub fn set_definition(self, input: Option<String>) -> Self
The Amazon States Language definition of the state machine. See Amazon States Language.
Sourcepub fn get_definition(&self) -> &Option<String>
pub fn get_definition(&self) -> &Option<String>
The Amazon States Language definition of the state machine. See Amazon States Language.
Sourcepub fn role_arn(self, input: impl Into<String>) -> Self
pub fn role_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the IAM role of the state machine.
Sourcepub fn set_role_arn(self, input: Option<String>) -> Self
pub fn set_role_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the IAM role of the state machine.
Sourcepub fn get_role_arn(&self) -> &Option<String>
pub fn get_role_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the IAM role of the state machine.
Sourcepub fn logging_configuration(self, input: LoggingConfiguration) -> Self
pub fn logging_configuration(self, input: LoggingConfiguration) -> Self
Use the LoggingConfiguration data type to set CloudWatch Logs options.
Sourcepub fn set_logging_configuration(
self,
input: Option<LoggingConfiguration>,
) -> Self
pub fn set_logging_configuration( self, input: Option<LoggingConfiguration>, ) -> Self
Use the LoggingConfiguration data type to set CloudWatch Logs options.
Sourcepub fn get_logging_configuration(&self) -> &Option<LoggingConfiguration>
pub fn get_logging_configuration(&self) -> &Option<LoggingConfiguration>
Use the LoggingConfiguration data type to set CloudWatch Logs options.
Sourcepub fn tracing_configuration(self, input: TracingConfiguration) -> Self
pub fn tracing_configuration(self, input: TracingConfiguration) -> Self
Selects whether X-Ray tracing is enabled.
Sourcepub fn set_tracing_configuration(
self,
input: Option<TracingConfiguration>,
) -> Self
pub fn set_tracing_configuration( self, input: Option<TracingConfiguration>, ) -> Self
Selects whether X-Ray tracing is enabled.
Sourcepub fn get_tracing_configuration(&self) -> &Option<TracingConfiguration>
pub fn get_tracing_configuration(&self) -> &Option<TracingConfiguration>
Selects whether X-Ray tracing is enabled.
Sourcepub fn publish(self, input: bool) -> Self
pub fn publish(self, input: bool) -> Self
Specifies whether the state machine version is published. The default is false. To publish a version after updating the state machine, set publish to true.
Sourcepub fn set_publish(self, input: Option<bool>) -> Self
pub fn set_publish(self, input: Option<bool>) -> Self
Specifies whether the state machine version is published. The default is false. To publish a version after updating the state machine, set publish to true.
Sourcepub fn get_publish(&self) -> &Option<bool>
pub fn get_publish(&self) -> &Option<bool>
Specifies whether the state machine version is published. The default is false. To publish a version after updating the state machine, set publish to true.
Sourcepub fn version_description(self, input: impl Into<String>) -> Self
pub fn version_description(self, input: impl Into<String>) -> Self
An optional description of the state machine version to publish.
You can only specify the versionDescription parameter if you've set publish to true.
Sourcepub fn set_version_description(self, input: Option<String>) -> Self
pub fn set_version_description(self, input: Option<String>) -> Self
An optional description of the state machine version to publish.
You can only specify the versionDescription parameter if you've set publish to true.
Sourcepub fn get_version_description(&self) -> &Option<String>
pub fn get_version_description(&self) -> &Option<String>
An optional description of the state machine version to publish.
You can only specify the versionDescription parameter if you've set publish to true.
Sourcepub fn encryption_configuration(self, input: EncryptionConfiguration) -> Self
pub fn encryption_configuration(self, input: EncryptionConfiguration) -> Self
Settings to configure server-side encryption.
Sourcepub fn set_encryption_configuration(
self,
input: Option<EncryptionConfiguration>,
) -> Self
pub fn set_encryption_configuration( self, input: Option<EncryptionConfiguration>, ) -> Self
Settings to configure server-side encryption.
Sourcepub fn get_encryption_configuration(&self) -> &Option<EncryptionConfiguration>
pub fn get_encryption_configuration(&self) -> &Option<EncryptionConfiguration>
Settings to configure server-side encryption.
Trait Implementations§
Source§impl Clone for UpdateStateMachineFluentBuilder
impl Clone for UpdateStateMachineFluentBuilder
Source§fn clone(&self) -> UpdateStateMachineFluentBuilder
fn clone(&self) -> UpdateStateMachineFluentBuilder
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 UpdateStateMachineFluentBuilder
impl !RefUnwindSafe for UpdateStateMachineFluentBuilder
impl Send for UpdateStateMachineFluentBuilder
impl Sync for UpdateStateMachineFluentBuilder
impl Unpin for UpdateStateMachineFluentBuilder
impl !UnwindSafe for UpdateStateMachineFluentBuilder
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);