AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateStateMachine operation. Creates a state machine. A state machine consists of a collection of states that can do work (Task states), determine to which states to transition next (Choice states), stop an execution with an error (Fail states), and so on. State machines are specified using a JSON-based, structured language. For more information, see Amazon States Language in the Step Functions User Guide.

If you set the publish parameter of this API action to true, it publishes version 1 as the first revision of the state machine.

For additional control over security, you can encrypt your data using a customer-managed key for Step Functions state machines. You can configure a symmetric KMS key and data key reuse period when creating or updating a State Machine. The execution history and state machine definition will be encrypted with the key applied to the State Machine.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

CreateStateMachine is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateStateMachine's idempotency check is based on the state machine name, definition, type, LoggingConfiguration, TracingConfiguration, and EncryptionConfiguration The check is also based on the publish and versionDescription parameters. If a following request has a different roleArn or tags, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, roleArn and tags will not be updated, even if they are different.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.StepFunctions.AmazonStepFunctionsRequest
      Amazon.StepFunctions.Model.CreateStateMachineRequest

Namespace: Amazon.StepFunctions.Model
Assembly: AWSSDK.StepFunctions.dll
Version: 3.x.y.z

Syntax

C# 
public class CreateStateMachineRequest : AmazonStepFunctionsRequest
         IAmazonWebServiceRequest

The CreateStateMachineRequest type exposes the following members

Constructors

NameDescription
Public Method CreateStateMachineRequest()

Properties

NameTypeDescription
Public Property Definition System.String

Gets and sets the property Definition.

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

Public Property EncryptionConfiguration Amazon.StepFunctions.Model.EncryptionConfiguration

Gets and sets the property EncryptionConfiguration.

Settings to configure server-side encryption.

Public Property LoggingConfiguration Amazon.StepFunctions.Model.LoggingConfiguration

Gets and sets the property 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.

Public Property Name System.String

Gets and sets the property Name.

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 _.

Public Property Publish System.Boolean

Gets and sets the property Publish.

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

Public Property RoleArn System.String

Gets and sets the property RoleArn.

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

Public Property Tags System.Collections.Generic.List<Amazon.StepFunctions.Model.Tag>

Gets and sets the property Tags.

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: _ . : / = + - @.

Public Property TracingConfiguration Amazon.StepFunctions.Model.TracingConfiguration

Gets and sets the property TracingConfiguration.

Selects whether X-Ray tracing is enabled.

Public Property Type Amazon.StepFunctions.StateMachineType

Gets and sets the property Type.

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.

Public Property VersionDescription System.String

Gets and sets the property VersionDescription.

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.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5