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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
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
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#definition ⇒ String

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

[1]: docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html

Returns:

  • (String) 


253
254
255
256
257
258
 
# File 'lib/aws-sdk-states/types.rb', line 253

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

#name ⇒ String

The name of the state machine.

A name must not contain:

  • whitespace

  • brackets ‘< > { } [ ]`

  • wildcard characters ‘? *`

  • special characters “ “ # % \ ^ | ~ ‘ $ & , ; : / “

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

Returns:

  • (String) 


253
254
255
256
257
258
 
# File 'lib/aws-sdk-states/types.rb', line 253

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

#role_arn ⇒ String

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

Returns:

  • (String) 


253
254
255
256
257
258
 
# File 'lib/aws-sdk-states/types.rb', line 253

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