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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-states/lib/aws-sdk-states/types.rb

Overview

Note:

When making an API call, you may pass CreateStateMachineInput data as a hash:

{
  name: "Name", # required
  definition: "Definition", # required
  role_arn: "Arn", # required
}

Instance Attribute Summary collapse

Instance Attribute Details

#definitionString

The Amazon States Language definition of the state machine.

Returns:

  • (String)


255
256
257
258
259
260
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 255

class CreateStateMachineInput < Struct.new(
  :name,
  :definition,
  :role_arn)
  include Aws::Structure
end

#nameString

The name of the state machine. This name must be unique for your AWS account and region for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.

A name must not contain:

  • whitespace

  • brackets < > \{ \} [ ]

  • wildcard characters ? *

  • special characters " # % \ ^ | ~ ` $ & , ; : /

  • control characters (U+0000-001F, U+007F-009F)

Returns:

  • (String)


255
256
257
258
259
260
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 255

class CreateStateMachineInput < Struct.new(
  :name,
  :definition,
  :role_arn)
  include Aws::Structure
end

#role_arnString

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

Returns:

  • (String)


255
256
257
258
259
260
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 255

class CreateStateMachineInput < Struct.new(
  :name,
  :definition,
  :role_arn)
  include Aws::Structure
end