Class: AWSCDK::StepFunctionsTasks::EMRAddStepJsonataProps

Inherits:
AWSCDK::StepFunctions::TaskStateJsonataBaseProps
  • Object
show all
Defined in:
step_functions_tasks/emr_add_step_jsonata_props.rb

Overview

Properties for EmrAddStep using JSONata.

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, cluster_id:, jar:, name:, action_on_failure: nil, args: nil, execution_role_arn: nil, main_class: nil, properties: nil) ⇒ EMRAddStepJsonataProps

Returns a new instance of EMRAddStepJsonataProps.

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.

  • cluster_id (String) —

    The ClusterId to add the Step to.

  • jar (String) —

    A path to a JAR file run during the step.

  • name (String) —

    The name of the Step.

  • action_on_failure (AWSCDK::StepFunctionsTasks::ActionOnFailure, nil) (defaults to: nil) —

    The action to take when the cluster step fails.

  • args (Array<String>, nil) (defaults to: nil) —

    A list of command line arguments passed to the JAR file's main function when executed.

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

    The Amazon Resource Name (ARN) of the runtime role for a step on the cluster.

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

    The name of the main class in the specified Java file.

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

    A list of Java properties that are set when the step runs.



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'step_functions_tasks/emr_add_step_jsonata_props.rb', line 26

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, cluster_id:, jar:, name:, action_on_failure: nil, args: nil, execution_role_arn: nil, main_class: nil, properties: 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?
  @cluster_id = cluster_id
  Jsii::Type.check_type(@cluster_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clusterId")
  @jar = jar
  Jsii::Type.check_type(@jar, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "jar")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @action_on_failure = action_on_failure
  Jsii::Type.check_type(@action_on_failure, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9uc190YXNrcy5BY3Rpb25PbkZhaWx1cmUifQ==")), "actionOnFailure") unless @action_on_failure.nil?
  @args = args
  Jsii::Type.check_type(@args, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "args") unless @args.nil?
  @execution_role_arn = execution_role_arn
  Jsii::Type.check_type(@execution_role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "executionRoleArn") unless @execution_role_arn.nil?
  @main_class = main_class
  Jsii::Type.check_type(@main_class, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "mainClass") unless @main_class.nil?
  @properties = properties
  Jsii::Type.check_type(@properties, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "properties") unless @properties.nil?
end

Instance Attribute Details

#action_on_failure ⇒ AWSCDK::StepFunctionsTasks::ActionOnFailure? (readonly)

Note:

Default: ActionOnFailure.CONTINUE

The action to take when the cluster step fails.

Returns:

See Also:



170
171
172
 
# File 'step_functions_tasks/emr_add_step_jsonata_props.rb', line 170

def action_on_failure
  @action_on_failure
end

#args ⇒ Array<String>? (readonly)

Note:

Default: - No args

A list of command line arguments passed to the JAR file's main function when executed.

Returns:

  • (Array<String>, nil)

See Also:



176
177
178
 
# File 'step_functions_tasks/emr_add_step_jsonata_props.rb', line 176

def args
  @args
end

#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:



138
139
140
 
# File 'step_functions_tasks/emr_add_step_jsonata_props.rb', line 138

def assign
  @assign
end

#cluster_id ⇒ String (readonly)

The ClusterId to add the Step to.

Returns:

  • (String) 


154
155
156
 
# File 'step_functions_tasks/emr_add_step_jsonata_props.rb', line 154

def cluster_id
  @cluster_id
end

#comment ⇒ String? (readonly)

Note:

Default: No comment

A comment describing this state.

Returns:

  • (String, nil) 


71
72
73
 
# File 'step_functions_tasks/emr_add_step_jsonata_props.rb', line 71

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:



92
93
94
 
# File 'step_functions_tasks/emr_add_step_jsonata_props.rb', line 92

def credentials
  @credentials
end

#execution_role_arn ⇒ String? (readonly)

Note:

Default: - Uses EC2 instance profile role

The Amazon Resource Name (ARN) of the runtime role for a step on the cluster.

Returns:

  • (String, nil)

See Also:



182
183
184
 
# File 'step_functions_tasks/emr_add_step_jsonata_props.rb', line 182

def execution_role_arn
  @execution_role_arn
end

#heartbeat ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use heartbeatTimeout

Note:

Default: - None

Timeout for the heartbeat.

Returns:



98
99
100
 
# File 'step_functions_tasks/emr_add_step_jsonata_props.rb', line 98

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:



106
107
108
 
# File 'step_functions_tasks/emr_add_step_jsonata_props.rb', line 106

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:



116
117
118
 
# File 'step_functions_tasks/emr_add_step_jsonata_props.rb', line 116

def integration_pattern
  @integration_pattern
end

#jar ⇒ String (readonly)

A path to a JAR file run during the step.

Returns:

  • (String)

See Also:



159
160
161
 
# File 'step_functions_tasks/emr_add_step_jsonata_props.rb', line 159

def jar
  @jar
end

#main_class ⇒ String? (readonly)

Note:

Default: - No mainClass

The name of the main class in the specified Java file.

If not specified, the JAR file should specify a Main-Class in its manifest file.

Returns:

  • (String, nil)

See Also:



190
191
192
 
# File 'step_functions_tasks/emr_add_step_jsonata_props.rb', line 190

def main_class
  @main_class
end

#name ⇒ String (readonly)

The name of the Step.

Returns:

  • (String)

See Also:



164
165
166
 
# File 'step_functions_tasks/emr_add_step_jsonata_props.rb', line 164

def name
  @name
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:



150
151
152
 
# File 'step_functions_tasks/emr_add_step_jsonata_props.rb', line 150

def outputs
  @outputs
end

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

Note:

Default: - No properties

A list of Java properties that are set when the step runs.

You can use these properties to pass key value pairs to your main function.

Returns:

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

See Also:



198
199
200
 
# File 'step_functions_tasks/emr_add_step_jsonata_props.rb', line 198

def properties
  @properties
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:



79
80
81
 
# File 'step_functions_tasks/emr_add_step_jsonata_props.rb', line 79

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) 


84
85
86
 
# File 'step_functions_tasks/emr_add_step_jsonata_props.rb', line 84

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:



124
125
126
 
# File 'step_functions_tasks/emr_add_step_jsonata_props.rb', line 124

def task_timeout
  @task_timeout
end

#timeout ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use taskTimeout

Note:

Default: - None

Timeout for the task.

Returns:



130
131
132
 
# File 'step_functions_tasks/emr_add_step_jsonata_props.rb', line 130

def timeout
  @timeout
end

Class Method Details

.jsii_properties ⇒ Object 



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'step_functions_tasks/emr_add_step_jsonata_props.rb', line 200

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",
    :cluster_id => "clusterId",
    :jar => "jar",
    :name => "name",
    :action_on_failure => "actionOnFailure",
    :args => "args",
    :execution_role_arn => "executionRoleArn",
    :main_class => "mainClass",
    :properties => "properties",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'step_functions_tasks/emr_add_step_jsonata_props.rb', line 224

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,
    "clusterId" => @cluster_id,
    "jar" => @jar,
    "name" => @name,
    "actionOnFailure" => @action_on_failure,
    "args" => @args,
    "executionRoleArn" => @execution_role_arn,
    "mainClass" => @main_class,
    "properties" => @properties,
  })
  result.compact
end