Skip to contents

Creates a state machine

Source: R/sfn_operations.R
sfn_create_state_machine.Rd

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.

See https://www.paws-r-sdk.com/docs/sfn_create_state_machine/ for full documentation.

Usage

sfn_create_state_machine(
  name,
  definition,
  roleArn,
  type = NULL,
  loggingConfiguration = NULL,
  tags = NULL,
  tracingConfiguration = NULL,
  publish = NULL,
  versionDescription = NULL,
  encryptionConfiguration = NULL
)

Arguments

name

[required] 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 _.

[ ]: R:%20

definition

[required] The Amazon States Language definition of the state machine. See Amazon States Language.

roleArn

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

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.

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

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

tracingConfiguration

Selects whether X-Ray tracing is enabled.

publish

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

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.

encryptionConfiguration

Settings to configure server-side encryption.