Class: AWSCDK::StepFunctions::TaskStateJsonataBaseProps

Inherits:
StateBaseProps
  • Object
show all
Defined in:
step_functions/task_state_jsonata_base_props.rb

Overview

Props that are common to all tasks that using JSONata.

Direct Known Subclasses

AWSCDK::StepFunctionsTasks::AthenaGetQueryExecutionJsonataProps, AWSCDK::StepFunctionsTasks::AthenaGetQueryResultsJsonataProps, AWSCDK::StepFunctionsTasks::AthenaStartQueryExecutionJsonataProps, AWSCDK::StepFunctionsTasks::AthenaStopQueryExecutionJsonataProps, AWSCDK::StepFunctionsTasks::BatchSubmitJobJsonataProps, AWSCDK::StepFunctionsTasks::BedrockInvokeModelJsonataProps, AWSCDK::StepFunctionsTasks::CallAPIGatewayEndpointJsonataBaseProps, AWSCDK::StepFunctionsTasks::CallAWSServiceCrossRegionJsonataProps, AWSCDK::StepFunctionsTasks::CallAWSServiceJsonataProps, AWSCDK::StepFunctionsTasks::CodeBuildStartBuildBatchJsonataProps, AWSCDK::StepFunctionsTasks::CodeBuildStartBuildJsonataProps, AWSCDK::StepFunctionsTasks::DynamoDeleteItemJsonataProps, AWSCDK::StepFunctionsTasks::DynamoGetItemJsonataProps, AWSCDK::StepFunctionsTasks::DynamoPutItemJsonataProps, AWSCDK::StepFunctionsTasks::DynamoUpdateItemJsonataProps, AWSCDK::StepFunctionsTasks::ECSRunTaskJsonataProps, AWSCDK::StepFunctionsTasks::EKSCallJsonataProps, AWSCDK::StepFunctionsTasks::EMRAddStepJsonataProps, AWSCDK::StepFunctionsTasks::EMRCancelStepJsonataProps, AWSCDK::StepFunctionsTasks::EMRContainersCreateVirtualClusterJsonataProps, AWSCDK::StepFunctionsTasks::EMRContainersDeleteVirtualClusterJsonataProps, AWSCDK::StepFunctionsTasks::EMRContainersStartJobRunJsonataProps, AWSCDK::StepFunctionsTasks::EMRCreateClusterJsonataProps, AWSCDK::StepFunctionsTasks::EMRModifyInstanceFleetByNameJsonataProps, AWSCDK::StepFunctionsTasks::EMRModifyInstanceGroupByNameJsonataProps, AWSCDK::StepFunctionsTasks::EMRSetClusterTerminationProtectionJsonataProps, AWSCDK::StepFunctionsTasks::EMRTerminateClusterJsonataProps, AWSCDK::StepFunctionsTasks::EventBridgePutEventsJsonataProps, AWSCDK::StepFunctionsTasks::EventBridgeSchedulerCreateScheduleTaskJsonataProps, AWSCDK::StepFunctionsTasks::GlueDataBrewStartJobRunJsonataProps, AWSCDK::StepFunctionsTasks::GlueStartCrawlerRunJsonataProps, AWSCDK::StepFunctionsTasks::GlueStartJobRunJsonataProps, AWSCDK::StepFunctionsTasks::HttpInvokeJsonataProps, AWSCDK::StepFunctionsTasks::LambdaInvokeJsonataProps, AWSCDK::StepFunctionsTasks::MediaConvertCreateJobJsonataProps, AWSCDK::StepFunctionsTasks::SNSPublishJsonataProps, AWSCDK::StepFunctionsTasks::SQSSendMessageJsonataProps, AWSCDK::StepFunctionsTasks::SageMakerCreateEndpointConfigJsonataProps, AWSCDK::StepFunctionsTasks::SageMakerCreateEndpointJsonataProps, AWSCDK::StepFunctionsTasks::SageMakerCreateModelJsonataProps, AWSCDK::StepFunctionsTasks::SageMakerCreateTrainingJobJsonataProps, AWSCDK::StepFunctionsTasks::SageMakerCreateTransformJobJsonataProps, AWSCDK::StepFunctionsTasks::SageMakerUpdateEndpointJsonataProps, AWSCDK::StepFunctionsTasks::StepFunctionsInvokeActivityJsonataProps, AWSCDK::StepFunctionsTasks::StepFunctionsStartExecutionJsonataProps

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(comment: nil, query_language: nil, state_name: nil, credentials: nil, heartbeat: nil, heartbeat_timeout: nil, integration_pattern: nil, task_timeout: nil, timeout: nil, assign: nil, outputs: nil) ⇒ TaskStateJsonataBaseProps

Returns a new instance of TaskStateJsonataBaseProps.

Parameters:

  • comment (String, nil) (defaults to: nil) —

    A comment describing this state.

  • query_language (AWSCDK::StepFunctions::QueryLanguage, nil) (defaults to: nil) —

    The name of the query language used by the state.

  • state_name (String, nil) (defaults to: nil) —

    Optional name for this state.

  • credentials (AWSCDK::StepFunctions::Credentials, nil) (defaults to: nil) —

    Credentials for an IAM Role that the State Machine assumes for executing the task.

  • heartbeat (AWSCDK::Duration, nil) (defaults to: nil) —

    Timeout for the heartbeat.

  • heartbeat_timeout (AWSCDK::StepFunctions::Timeout, nil) (defaults to: nil) —

    Timeout for the heartbeat.

  • integration_pattern (AWSCDK::StepFunctions::IntegrationPattern, nil) (defaults to: nil) —

    AWS Step Functions integrates with services directly in the Amazon States Language.

  • task_timeout (AWSCDK::StepFunctions::Timeout, nil) (defaults to: nil) —

    Timeout for the task.

  • timeout (AWSCDK::Duration, nil) (defaults to: nil) —

    Timeout for the task.

  • assign (Hash{String => Object}, nil) (defaults to: nil) —

    Workflow variables to store in this step.

  • outputs (Object, nil) (defaults to: nil) —

    Used to specify and transform output from the state.



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'step_functions/task_state_jsonata_base_props.rb', line 19

def initialize(comment: nil, query_language: nil, state_name: nil, credentials: nil, heartbeat: nil, heartbeat_timeout: nil, integration_pattern: nil, task_timeout: nil, timeout: nil, assign: nil, outputs: nil)
  @comment = comment
  Jsii::Type.check_type(@comment, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "comment") unless @comment.nil?
  @query_language = query_language
  Jsii::Type.check_type(@query_language, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5RdWVyeUxhbmd1YWdlIn0=")), "queryLanguage") unless @query_language.nil?
  @state_name = state_name
  Jsii::Type.check_type(@state_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stateName") unless @state_name.nil?
  @credentials = credentials.is_a?(Hash) ? ::AWSCDK::StepFunctions::Credentials.new(**credentials.transform_keys(&:to_sym)) : credentials
  Jsii::Type.check_type(@credentials, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5DcmVkZW50aWFscyJ9")), "credentials") unless @credentials.nil?
  @heartbeat = heartbeat
  Jsii::Type.check_type(@heartbeat, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5EdXJhdGlvbiJ9")), "heartbeat") unless @heartbeat.nil?
  @heartbeat_timeout = heartbeat_timeout
  Jsii::Type.check_type(@heartbeat_timeout, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5UaW1lb3V0In0=")), "heartbeatTimeout") unless @heartbeat_timeout.nil?
  @integration_pattern = integration_pattern
  Jsii::Type.check_type(@integration_pattern, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5JbnRlZ3JhdGlvblBhdHRlcm4ifQ==")), "integrationPattern") unless @integration_pattern.nil?
  @task_timeout = task_timeout
  Jsii::Type.check_type(@task_timeout, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5UaW1lb3V0In0=")), "taskTimeout") unless @task_timeout.nil?
  @timeout = timeout
  Jsii::Type.check_type(@timeout, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5EdXJhdGlvbiJ9")), "timeout") unless @timeout.nil?
  @assign = assign
  Jsii::Type.check_type(@assign, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "assign") unless @assign.nil?
  @outputs = outputs
  Jsii::Type.check_type(@outputs, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "outputs") unless @outputs.nil?
end

Instance Attribute Details

#assign ⇒ Hash{String => Object}? (readonly)

Note:

Default: - Not assign variables

Workflow variables to store in this step.

Using workflow variables, you can store data in a step and retrieve that data in future steps.

Returns:

  • (Hash{String => Object}, nil)

See Also:



115
116
117
 
# File 'step_functions/task_state_jsonata_base_props.rb', line 115

def assign
  @assign
end

#comment ⇒ String? (readonly)

Note:

Default: No comment

A comment describing this state.

Returns:

  • (String, nil) 


48
49
50
 
# File 'step_functions/task_state_jsonata_base_props.rb', line 48

def comment
  @comment
end

#credentials ⇒ AWSCDK::StepFunctions::Credentials? (readonly)

Note:

Default: - None (Task is executed using the State Machine's execution role)

Credentials for an IAM Role that the State Machine assumes for executing the task.

This enables cross-account resource invocations.

Returns:

See Also:



69
70
71
 
# File 'step_functions/task_state_jsonata_base_props.rb', line 69

def credentials
  @credentials
end

#heartbeat ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use heartbeatTimeout

Note:

Default: - None

Timeout for the heartbeat.

Returns:



75
76
77
 
# File 'step_functions/task_state_jsonata_base_props.rb', line 75

def heartbeat
  @heartbeat
end

#heartbeat_timeout ⇒ AWSCDK::StepFunctions::Timeout? (readonly)

Note:

Default: - None

Timeout for the heartbeat.

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Returns:



83
84
85
 
# File 'step_functions/task_state_jsonata_base_props.rb', line 83

def heartbeat_timeout
  @heartbeat_timeout
end

#integration_pattern ⇒ AWSCDK::StepFunctions::IntegrationPattern? (readonly)

Note:

Default: - IntegrationPattern.REQUEST_RESPONSE for most tasks. IntegrationPattern.RUN_JOB for the following exceptions: BatchSubmitJob, EmrAddStep, EmrCreateCluster, EmrTerminationCluster, and EmrContainersStartJobRun.

AWS Step Functions integrates with services directly in the Amazon States Language.

You can control these AWS services using service integration patterns.

Depending on the AWS Service, the Service Integration Pattern availability will vary.

Returns:

See Also:



93
94
95
 
# File 'step_functions/task_state_jsonata_base_props.rb', line 93

def integration_pattern
  @integration_pattern
end

#outputs ⇒ Object? (readonly)

Note:

Default: - $states.result or $states.errorOutput

Used to specify and transform output from the state.

When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by % characters. Output also accepts a JSONata expression directly.

Returns:

  • (Object, nil)

See Also:



127
128
129
 
# File 'step_functions/task_state_jsonata_base_props.rb', line 127

def outputs
  @outputs
end

#query_language ⇒ AWSCDK::StepFunctions::QueryLanguage? (readonly)

Note:

Default: - JSONPath

The name of the query language used by the state.

If the state does not contain a query_language field, then it will use the query language specified in the top-level query_language field.

Returns:



56
57
58
 
# File 'step_functions/task_state_jsonata_base_props.rb', line 56

def query_language
  @query_language
end

#state_name ⇒ String? (readonly)

Note:

Default: - The construct ID will be used as state name

Optional name for this state.

Returns:

  • (String, nil) 


61
62
63
 
# File 'step_functions/task_state_jsonata_base_props.rb', line 61

def state_name
  @state_name
end

#task_timeout ⇒ AWSCDK::StepFunctions::Timeout? (readonly)

Note:

Default: - None

Timeout for the task.

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Returns:



101
102
103
 
# File 'step_functions/task_state_jsonata_base_props.rb', line 101

def task_timeout
  @task_timeout
end

#timeout ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use taskTimeout

Note:

Default: - None

Timeout for the task.

Returns:



107
108
109
 
# File 'step_functions/task_state_jsonata_base_props.rb', line 107

def timeout
  @timeout
end

Class Method Details

.jsii_properties ⇒ Object 



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'step_functions/task_state_jsonata_base_props.rb', line 129

def self.jsii_properties
  {
    :comment => "comment",
    :query_language => "queryLanguage",
    :state_name => "stateName",
    :credentials => "credentials",
    :heartbeat => "heartbeat",
    :heartbeat_timeout => "heartbeatTimeout",
    :integration_pattern => "integrationPattern",
    :task_timeout => "taskTimeout",
    :timeout => "timeout",
    :assign => "assign",
    :outputs => "outputs",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'step_functions/task_state_jsonata_base_props.rb', line 145

def to_jsii
  result = {}
  result.merge!(super)
  result.merge!({
    "comment" => @comment,
    "queryLanguage" => @query_language,
    "stateName" => @state_name,
    "credentials" => @credentials,
    "heartbeat" => @heartbeat,
    "heartbeatTimeout" => @heartbeat_timeout,
    "integrationPattern" => @integration_pattern,
    "taskTimeout" => @task_timeout,
    "timeout" => @timeout,
    "assign" => @assign,
    "outputs" => @outputs,
  })
  result.compact
end