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

Inherits:

Struct

• Object
• Struct
• Aws::States::Types::CreateStateMachineInput

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
  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:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:definition]

Instance Attribute Summary

• #definition ⇒ 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.

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

• #tags ⇒ Array<Types::Tag>

  Tags to be added when creating a state machine.

• #tracing_configuration ⇒ Types::TracingConfiguration

  Selects whether AWS X-Ray tracing is enabled.

• #type ⇒ String

  Determines whether a Standard or Express state machine is created.

Instance Attribute Details

#definition ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 464

class CreateStateMachineInput < Struct.new(
  :name,
  :definition,
  :role_arn,
  :type,
  :logging_configuration,
  :tags,
  :tracing_configuration)
  SENSITIVE = [:definition]
  include Aws::Structure
end

#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:

• (Types::LoggingConfiguration)

# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 464

class CreateStateMachineInput < Struct.new(
  :name,
  :definition,
  :role_arn,
  :type,
  :logging_configuration,
  :tags,
  :tracing_configuration)
  SENSITIVE = [:definition]
  include Aws::Structure
end

#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)

# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 464

class CreateStateMachineInput < Struct.new(
  :name,
  :definition,
  :role_arn,
  :type,
  :logging_configuration,
  :tags,
  :tracing_configuration)
  SENSITIVE = [:definition]
  include Aws::Structure
end

#role_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 464

class CreateStateMachineInput < Struct.new(
  :name,
  :definition,
  :role_arn,
  :type,
  :logging_configuration,
  :tags,
  :tracing_configuration)
  SENSITIVE = [:definition]
  include Aws::Structure
end

#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>)

# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 464

class CreateStateMachineInput < Struct.new(
  :name,
  :definition,
  :role_arn,
  :type,
  :logging_configuration,
  :tags,
  :tracing_configuration)
  SENSITIVE = [:definition]
  include Aws::Structure
end

#tracing_configuration ⇒ Types::TracingConfiguration

Selects whether AWS X-Ray tracing is enabled.

Returns:

• (Types::TracingConfiguration)

# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 464

class CreateStateMachineInput < Struct.new(
  :name,
  :definition,
  :role_arn,
  :type,
  :logging_configuration,
  :tags,
  :tracing_configuration)
  SENSITIVE = [:definition]
  include Aws::Structure
end

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

Returns:

• (String)

# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 464

class CreateStateMachineInput < Struct.new(
  :name,
  :definition,
  :role_arn,
  :type,
  :logging_configuration,
  :tags,
  :tracing_configuration)
  SENSITIVE = [:definition]
  include Aws::Structure
end