#[non_exhaustive]pub struct CreateStateMachineInput {
pub name: Option<String>,
pub definition: Option<String>,
pub role_arn: Option<String>,
pub type: Option<StateMachineType>,
pub logging_configuration: Option<LoggingConfiguration>,
pub tags: Option<Vec<Tag>>,
pub tracing_configuration: Option<TracingConfiguration>,
pub publish: Option<bool>,
pub version_description: Option<String>,
pub encryption_configuration: Option<EncryptionConfiguration>,
}
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.name: Option<String>
The name of the state machine.
A name must not contain:
-
white space
-
brackets
< > { } \[ \]
-
wildcard characters
? *
-
special characters
" # % \ ^ | ~ ` $ & , ; : /
-
control characters (
U+0000-001F
,U+007F-009F
,U+FFFE-FFFF
) -
surrogates (
U+D800-DFFF
) -
invalid characters (
U+10FFFF
)
To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
definition: Option<String>
The Amazon States Language definition of the state machine. See Amazon States Language.
role_arn: Option<String>
The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
type: Option<StateMachineType>
Determines whether a Standard or Express state machine is created. The default is STANDARD
. You cannot update the type
of a state machine once it has been created.
logging_configuration: Option<LoggingConfiguration>
Defines what execution history events are logged and where they are logged.
By default, the level
is set to OFF
. For more information see Log Levels in the Step Functions User Guide.
Tags to be added when creating a state machine.
An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @
.
tracing_configuration: Option<TracingConfiguration>
Selects whether X-Ray tracing is enabled.
publish: Option<bool>
Set to true
to publish the first version of the state machine during creation. The default is false
.
version_description: Option<String>
Sets description about the state machine version. You can only set the description if the publish
parameter is set to true
. Otherwise, if you set versionDescription
, but publish
to false
, this API action throws ValidationException
.
encryption_configuration: Option<EncryptionConfiguration>
Settings to configure server-side encryption.
Implementations§
Source§impl CreateStateMachineInput
impl CreateStateMachineInput
Sourcepub fn name(&self) -> Option<&str>
pub fn name(&self) -> Option<&str>
The name of the state machine.
A name must not contain:
-
white space
-
brackets
< > { } \[ \]
-
wildcard characters
? *
-
special characters
" # % \ ^ | ~ ` $ & , ; : /
-
control characters (
U+0000-001F
,U+007F-009F
,U+FFFE-FFFF
) -
surrogates (
U+D800-DFFF
) -
invalid characters (
U+10FFFF
)
To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
Sourcepub fn definition(&self) -> Option<&str>
pub fn definition(&self) -> Option<&str>
The Amazon States Language definition of the state machine. See Amazon States Language.
Sourcepub fn role_arn(&self) -> Option<&str>
pub fn role_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
Sourcepub fn type(&self) -> Option<&StateMachineType>
pub fn type(&self) -> Option<&StateMachineType>
Determines whether a Standard or Express state machine is created. The default is STANDARD
. You cannot update the type
of a state machine once it has been created.
Sourcepub fn logging_configuration(&self) -> Option<&LoggingConfiguration>
pub fn logging_configuration(&self) -> Option<&LoggingConfiguration>
Defines what execution history events are logged and where they are logged.
By default, the level
is set to OFF
. For more information see Log Levels in the Step Functions User Guide.
Tags to be added when creating a state machine.
An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @
.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none()
.
Sourcepub fn tracing_configuration(&self) -> Option<&TracingConfiguration>
pub fn tracing_configuration(&self) -> Option<&TracingConfiguration>
Selects whether X-Ray tracing is enabled.
Sourcepub fn publish(&self) -> Option<bool>
pub fn publish(&self) -> Option<bool>
Set to true
to publish the first version of the state machine during creation. The default is false
.
Sourcepub fn version_description(&self) -> Option<&str>
pub fn version_description(&self) -> Option<&str>
Sets description about the state machine version. You can only set the description if the publish
parameter is set to true
. Otherwise, if you set versionDescription
, but publish
to false
, this API action throws ValidationException
.
Sourcepub fn encryption_configuration(&self) -> Option<&EncryptionConfiguration>
pub fn encryption_configuration(&self) -> Option<&EncryptionConfiguration>
Settings to configure server-side encryption.
Source§impl CreateStateMachineInput
impl CreateStateMachineInput
Sourcepub fn builder() -> CreateStateMachineInputBuilder
pub fn builder() -> CreateStateMachineInputBuilder
Creates a new builder-style object to manufacture CreateStateMachineInput
.
Trait Implementations§
Source§impl Clone for CreateStateMachineInput
impl Clone for CreateStateMachineInput
Source§fn clone(&self) -> CreateStateMachineInput
fn clone(&self) -> CreateStateMachineInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for CreateStateMachineInput
impl Debug for CreateStateMachineInput
Source§impl PartialEq for CreateStateMachineInput
impl PartialEq for CreateStateMachineInput
impl StructuralPartialEq for CreateStateMachineInput
Auto Trait Implementations§
impl Freeze for CreateStateMachineInput
impl RefUnwindSafe for CreateStateMachineInput
impl Send for CreateStateMachineInput
impl Sync for CreateStateMachineInput
impl Unpin for CreateStateMachineInput
impl UnwindSafe for CreateStateMachineInput
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);