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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:definition, :version_description]

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) 


544
545
546
547
548
549
550
551
552
553
554
555
556
557
 
# File 'lib/aws-sdk-states/types.rb', line 544

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

#encryption_configuration ⇒ Types::EncryptionConfiguration

Settings to configure server-side encryption.

Returns:



544
545
546
547
548
549
550
551
552
553
554
555
556
557
 
# File 'lib/aws-sdk-states/types.rb', line 544

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

#logging_configuration ⇒ Types::LoggingConfiguration

Defines what execution history events are logged and where they are logged.

<note markdown=“1”> By default, the level is set to OFF. For more information see

Log Levels][1

in the Step Functions User Guide.

</note>

[1]: docs.aws.amazon.com/step-functions/latest/dg/cloudwatch-log-level.html

Returns:



544
545
546
547
548
549
550
551
552
553
554
555
556
557
 
# File 'lib/aws-sdk-states/types.rb', line 544

class CreateStateMachineInput < Struct.new(
  :name,
  :definition,
  :role_arn,
  :type,
  :logging_configuration,
  :tags,
  :tracing_configuration,
  :publish,
  :version_description,
  :encryption_configuration)
  SENSITIVE = [:definition, :version_description]
  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`, `U+FFFE-FFFF`)

  • surrogates (‘U+D800-DFFF`)

  • invalid characters (‘ U+10FFFF`)

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

Returns:

  • (String) 


544
545
546
547
548
549
550
551
552
553
554
555
556
557
 
# File 'lib/aws-sdk-states/types.rb', line 544

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

#publish ⇒ Boolean

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

Returns:

  • (Boolean) 


544
545
546
547
548
549
550
551
552
553
554
555
556
557
 
# File 'lib/aws-sdk-states/types.rb', line 544

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

#role_arn ⇒ String

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

Returns:

  • (String) 


544
545
546
547
548
549
550
551
552
553
554
555
556
557
 
# File 'lib/aws-sdk-states/types.rb', line 544

class CreateStateMachineInput < Struct.new(
  :name,
  :definition,
  :role_arn,
  :type,
  :logging_configuration,
  :tags,
  :tracing_configuration,
  :publish,
  :version_description,
  :encryption_configuration)
  SENSITIVE = [:definition, :version_description]
  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 *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: ‘_ . : / = + - @`.

[1]: docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html

Returns:



544
545
546
547
548
549
550
551
552
553
554
555
556
557
 
# File 'lib/aws-sdk-states/types.rb', line 544

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

#tracing_configuration ⇒ Types::TracingConfiguration

Selects whether X-Ray tracing is enabled.

Returns:



544
545
546
547
548
549
550
551
552
553
554
555
556
557
 
# File 'lib/aws-sdk-states/types.rb', line 544

class CreateStateMachineInput < Struct.new(
  :name,
  :definition,
  :role_arn,
  :type,
  :logging_configuration,
  :tags,
  :tracing_configuration,
  :publish,
  :version_description,
  :encryption_configuration)
  SENSITIVE = [:definition, :version_description]
  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) 


544
545
546
547
548
549
550
551
552
553
554
555
556
557
 
# File 'lib/aws-sdk-states/types.rb', line 544

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

#version_description ⇒ String

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) 


544
545
546
547
548
549
550
551
552
553
554
555
556
557
 
# File 'lib/aws-sdk-states/types.rb', line 544

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