You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::States::Types::CreateStateMachineInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateStateMachineInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "Name", # required
  definition: "Definition", # required
  role_arn: "Arn", # required
  type: "STANDARD", # accepts STANDARD, EXPRESS
  logging_configuration: {
    level: "ALL", # accepts ALL, ERROR, FATAL, OFF
    include_execution_data: false,
    destinations: [
      {
        cloud_watch_logs_log_group: {
          log_group_arn: "Arn",
        },
      },
    ],
  },
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
  tracing_configuration: {
    enabled: false,
  },
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#definition ⇒ String

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

Returns:

  • (String) —

    The Amazon States Language definition of the state machine.

#logging_configuration ⇒ Types::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 AWS Step Functions User Guide.

Returns:

#name ⇒ 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 _.

Returns:

  • (String) —

    The name of the state machine.

#role_arn ⇒ String

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

Returns:

  • (String) —

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

#tags ⇒ Array<Types::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 AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

Returns:

  • (Array<Types::Tag>) —

    Tags to be added when creating a state machine.

#tracing_configuration ⇒ Types::TracingConfiguration

Selects whether AWS X-Ray tracing is enabled.

Returns:

#type ⇒ String

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.

Possible values:

  • STANDARD
  • EXPRESS

Returns:

  • (String) —

    Determines whether a Standard or Express state machine is created.