Class: Aws::States::Types::DescribeStateMachineOutput
- Inherits:
-
Struct
- Object
- Struct
- Aws::States::Types::DescribeStateMachineOutput
- Includes:
- Aws::Structure
- Defined in:
- lib/aws-sdk-states/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[:definition]
Instance Attribute Summary collapse
-
#creation_date ⇒ Time
The date the state machine is created.
-
#definition ⇒ String
The Amazon States Language definition of the state machine.
-
#logging_configuration ⇒ Types::LoggingConfiguration
The ‘LoggingConfiguration` data type is used to set CloudWatch Logs options.
-
#name ⇒ String
The name of the state machine.
-
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the IAM role used when creating this state machine.
-
#state_machine_arn ⇒ String
The Amazon Resource Name (ARN) that identifies the state machine.
-
#status ⇒ String
The current status of the state machine.
-
#type ⇒ String
The ‘type` of the state machine (`STANDARD` or `EXPRESS`).
Instance Attribute Details
#creation_date ⇒ Time
The date the state machine is created.
812 813 814 815 816 817 818 819 820 821 822 823 |
# File 'lib/aws-sdk-states/types.rb', line 812 class DescribeStateMachineOutput < Struct.new( :state_machine_arn, :name, :status, :definition, :role_arn, :type, :creation_date, :logging_configuration) SENSITIVE = [:definition] include Aws::Structure end |
#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
812 813 814 815 816 817 818 819 820 821 822 823 |
# File 'lib/aws-sdk-states/types.rb', line 812 class DescribeStateMachineOutput < Struct.new( :state_machine_arn, :name, :status, :definition, :role_arn, :type, :creation_date, :logging_configuration) SENSITIVE = [:definition] include Aws::Structure end |
#logging_configuration ⇒ Types::LoggingConfiguration
The ‘LoggingConfiguration` data type is used to set CloudWatch Logs options.
812 813 814 815 816 817 818 819 820 821 822 823 |
# File 'lib/aws-sdk-states/types.rb', line 812 class DescribeStateMachineOutput < Struct.new( :state_machine_arn, :name, :status, :definition, :role_arn, :type, :creation_date, :logging_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 _.
812 813 814 815 816 817 818 819 820 821 822 823 |
# File 'lib/aws-sdk-states/types.rb', line 812 class DescribeStateMachineOutput < Struct.new( :state_machine_arn, :name, :status, :definition, :role_arn, :type, :creation_date, :logging_configuration) SENSITIVE = [:definition] include Aws::Structure end |
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the IAM role used when creating this state machine. (The IAM role maintains security by granting Step Functions access to AWS resources.)
812 813 814 815 816 817 818 819 820 821 822 823 |
# File 'lib/aws-sdk-states/types.rb', line 812 class DescribeStateMachineOutput < Struct.new( :state_machine_arn, :name, :status, :definition, :role_arn, :type, :creation_date, :logging_configuration) SENSITIVE = [:definition] include Aws::Structure end |
#state_machine_arn ⇒ String
The Amazon Resource Name (ARN) that identifies the state machine.
812 813 814 815 816 817 818 819 820 821 822 823 |
# File 'lib/aws-sdk-states/types.rb', line 812 class DescribeStateMachineOutput < Struct.new( :state_machine_arn, :name, :status, :definition, :role_arn, :type, :creation_date, :logging_configuration) SENSITIVE = [:definition] include Aws::Structure end |
#status ⇒ String
The current status of the state machine.
812 813 814 815 816 817 818 819 820 821 822 823 |
# File 'lib/aws-sdk-states/types.rb', line 812 class DescribeStateMachineOutput < Struct.new( :state_machine_arn, :name, :status, :definition, :role_arn, :type, :creation_date, :logging_configuration) SENSITIVE = [:definition] include Aws::Structure end |
#type ⇒ String
The ‘type` of the state machine (`STANDARD` or `EXPRESS`).
812 813 814 815 816 817 818 819 820 821 822 823 |
# File 'lib/aws-sdk-states/types.rb', line 812 class DescribeStateMachineOutput < Struct.new( :state_machine_arn, :name, :status, :definition, :role_arn, :type, :creation_date, :logging_configuration) SENSITIVE = [:definition] include Aws::Structure end |