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

Inherits:

Struct

• Object
• Struct
• Aws::States::Types::UpdateStateMachineInput

Defined in:

gems/aws-sdk-states/lib/aws-sdk-states/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:definition, :version_description]

Instance Attribute Summary

• #definition ⇒ String

  The Amazon States Language definition of the state machine.

• #encryption_configuration ⇒ Types::EncryptionConfiguration

  Settings to configure server-side encryption.

• #logging_configuration ⇒ Types::LoggingConfiguration

  Use the LoggingConfiguration data type to set CloudWatch Logs options.

• #publish ⇒ Boolean

  Specifies whether the state machine version is published.

• #role_arn ⇒ String

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

• #state_machine_arn ⇒ String

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

• #tracing_configuration ⇒ Types::TracingConfiguration

  Selects whether X-Ray tracing is enabled.

• #version_description ⇒ String

  An optional description of the state machine version to publish.

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 4546

class UpdateStateMachineInput < Struct.new(
  :state_machine_arn,
  :definition,
  :role_arn,
  :logging_configuration,
  :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:

• (Types::EncryptionConfiguration)

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

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

#logging_configuration ⇒ Types::LoggingConfiguration

Use the LoggingConfiguration data type to set CloudWatch Logs options.

Returns:

• (Types::LoggingConfiguration)

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

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

#publish ⇒ Boolean

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)

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

class UpdateStateMachineInput < Struct.new(
  :state_machine_arn,
  :definition,
  :role_arn,
  :logging_configuration,
  :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 of the state machine.

Returns:

• (String)

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

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

#state_machine_arn ⇒ String

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

Returns:

• (String)

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

class UpdateStateMachineInput < Struct.new(
  :state_machine_arn,
  :definition,
  :role_arn,
  :logging_configuration,
  :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:

• (Types::TracingConfiguration)

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

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

#version_description ⇒ String

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)

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

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