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

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

Overview

Constant Summary collapse

SENSITIVE =
[:definition, :version_description]

Instance Attribute Summary collapse

Instance Attribute Details

#definitionString

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

Returns:

  • (String)


493
494
495
496
497
498
499
500
501
502
503
504
505
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 493

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

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



493
494
495
496
497
498
499
500
501
502
503
504
505
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 493

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

#nameString

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)


493
494
495
496
497
498
499
500
501
502
503
504
505
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 493

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

#publishBoolean

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

Returns:

  • (Boolean)


493
494
495
496
497
498
499
500
501
502
503
504
505
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 493

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

#role_arnString

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

Returns:

  • (String)


493
494
495
496
497
498
499
500
501
502
503
504
505
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 493

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

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

Returns:



493
494
495
496
497
498
499
500
501
502
503
504
505
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 493

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

#tracing_configurationTypes::TracingConfiguration

Selects whether X-Ray tracing is enabled.



493
494
495
496
497
498
499
500
501
502
503
504
505
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 493

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

#typeString

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)


493
494
495
496
497
498
499
500
501
502
503
504
505
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 493

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

#version_descriptionString

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.

Returns:

  • (String)


493
494
495
496
497
498
499
500
501
502
503
504
505
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 493

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