Class: Aws::States::Types::UpdateStateMachineInput

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

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

Returns:

  • (String)


4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
# File 'lib/aws-sdk-states/types.rb', line 4338

class UpdateStateMachineInput < Struct.new(
  :state_machine_arn,
  :definition,
  :role_arn,
  :logging_configuration,
  :tracing_configuration,
  :publish,
  :version_description)
  SENSITIVE = [:definition, :version_description]
  include Aws::Structure
end

#logging_configurationTypes::LoggingConfiguration

Use the ‘LoggingConfiguration` data type to set CloudWatch Logs options.



4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
# File 'lib/aws-sdk-states/types.rb', line 4338

class UpdateStateMachineInput < Struct.new(
  :state_machine_arn,
  :definition,
  :role_arn,
  :logging_configuration,
  :tracing_configuration,
  :publish,
  :version_description)
  SENSITIVE = [:definition, :version_description]
  include Aws::Structure
end

#publishBoolean

Specifies whether the state machine version is published. The default is ‘false`. To publish a version after updating the state machine, set `publish` to `true`.

Returns:

  • (Boolean)


4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
# File 'lib/aws-sdk-states/types.rb', line 4338

class UpdateStateMachineInput < Struct.new(
  :state_machine_arn,
  :definition,
  :role_arn,
  :logging_configuration,
  :tracing_configuration,
  :publish,
  :version_description)
  SENSITIVE = [:definition, :version_description]
  include Aws::Structure
end

#role_arnString

The Amazon Resource Name (ARN) of the IAM role of the state machine.

Returns:

  • (String)


4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
# File 'lib/aws-sdk-states/types.rb', line 4338

class UpdateStateMachineInput < Struct.new(
  :state_machine_arn,
  :definition,
  :role_arn,
  :logging_configuration,
  :tracing_configuration,
  :publish,
  :version_description)
  SENSITIVE = [:definition, :version_description]
  include Aws::Structure
end

#state_machine_arnString

The Amazon Resource Name (ARN) of the state machine.

Returns:

  • (String)


4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
# File 'lib/aws-sdk-states/types.rb', line 4338

class UpdateStateMachineInput < Struct.new(
  :state_machine_arn,
  :definition,
  :role_arn,
  :logging_configuration,
  :tracing_configuration,
  :publish,
  :version_description)
  SENSITIVE = [:definition, :version_description]
  include Aws::Structure
end

#tracing_configurationTypes::TracingConfiguration

Selects whether X-Ray tracing is enabled.



4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
# File 'lib/aws-sdk-states/types.rb', line 4338

class UpdateStateMachineInput < Struct.new(
  :state_machine_arn,
  :definition,
  :role_arn,
  :logging_configuration,
  :tracing_configuration,
  :publish,
  :version_description)
  SENSITIVE = [:definition, :version_description]
  include Aws::Structure
end

#version_descriptionString

An optional description of the state machine version to publish.

You can only specify the ‘versionDescription` parameter if you’ve set ‘publish` to `true`.

Returns:

  • (String)


4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
# File 'lib/aws-sdk-states/types.rb', line 4338

class UpdateStateMachineInput < Struct.new(
  :state_machine_arn,
  :definition,
  :role_arn,
  :logging_configuration,
  :tracing_configuration,
  :publish,
  :version_description)
  SENSITIVE = [:definition, :version_description]
  include Aws::Structure
end