Struct aws_sdk_sfn::operation::create_state_machine::CreateStateMachineInput

#[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>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional 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)

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: Option<Vec<Tag>>

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.

Implementations

impl CreateStateMachineInput

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)

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

pub fn definition(&self) -> Option<&str>

The Amazon States Language definition of the state machine. See Amazon States Language.

pub fn role_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the IAM role to use for this state machine.

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.

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.

pub fn tags(&self) -> &[Tag]

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().

pub fn tracing_configuration(&self) -> Option<&TracingConfiguration>

Selects whether X-Ray tracing is enabled.

pub fn publish(&self) -> Option<bool>

Set to true to publish the first version of the state machine during creation. The default is false.

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.

impl CreateStateMachineInput

pub fn builder() -> CreateStateMachineInputBuilder

Creates a new builder-style object to manufacture CreateStateMachineInput.

Trait Implementations

impl Clone for CreateStateMachineInput

fn clone(&self) -> CreateStateMachineInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateStateMachineInput

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

Formats the value using the given formatter.

impl PartialEq for CreateStateMachineInput

fn eq(&self, other: &CreateStateMachineInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateStateMachineInput