Class: AWSCDK::StepFunctionsTasks::EMRAddStepJsonPathProps

Inherits:
AWSCDK::StepFunctions::TaskStateJsonPathBaseProps
  • Object
show all
Defined in:
step_functions_tasks/emr_add_step_json_path_props.rb

Overview

Properties for EmrAddStep using JSONPath.

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, input_path: nil, output_path: nil, result_path: nil, result_selector: nil, cluster_id:, jar:, name:, action_on_failure: nil, args: nil, execution_role_arn: nil, main_class: nil, properties: nil) ⇒ EMRAddStepJsonPathProps

Returns a new instance of EMRAddStepJsonPathProps.

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.

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

    JSONPath expression to select part of the state to be the input to this state.

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

    JSONPath expression to select part of the state to be the output to this state.

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

    JSONPath expression to indicate where to inject the state's output.

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

    The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.

  • 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.



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
66
67
68
69
70
71
72
73
74
 
# File 'step_functions_tasks/emr_add_step_json_path_props.rb', line 29

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, input_path: nil, output_path: nil, result_path: nil, result_selector: 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?
  @input_path = input_path
  Jsii::Type.check_type(@input_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "inputPath") unless @input_path.nil?
  @output_path = output_path
  Jsii::Type.check_type(@output_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "outputPath") unless @output_path.nil?
  @result_path = result_path
  Jsii::Type.check_type(@result_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "resultPath") unless @result_path.nil?
  @result_selector = result_selector
  Jsii::Type.check_type(@result_selector, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "resultSelector") unless @result_selector.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:



200
201
202
 
# File 'step_functions_tasks/emr_add_step_json_path_props.rb', line 200

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:



206
207
208
 
# File 'step_functions_tasks/emr_add_step_json_path_props.rb', line 206

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:



147
148
149
 
# File 'step_functions_tasks/emr_add_step_json_path_props.rb', line 147

def assign
  @assign
end

#cluster_id ⇒ String (readonly)

The ClusterId to add the Step to.

Returns:

  • (String) 


184
185
186
 
# File 'step_functions_tasks/emr_add_step_json_path_props.rb', line 184

def cluster_id
  @cluster_id
end

#comment ⇒ String? (readonly)

Note:

Default: No comment

A comment describing this state.

Returns:

  • (String, nil) 


80
81
82
 
# File 'step_functions_tasks/emr_add_step_json_path_props.rb', line 80

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:



101
102
103
 
# File 'step_functions_tasks/emr_add_step_json_path_props.rb', line 101

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:



212
213
214
 
# File 'step_functions_tasks/emr_add_step_json_path_props.rb', line 212

def execution_role_arn
  @execution_role_arn
end

#heartbeat ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use heartbeatTimeout

Note:

Default: - None

Timeout for the heartbeat.

Returns:



107
108
109
 
# File 'step_functions_tasks/emr_add_step_json_path_props.rb', line 107

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:



115
116
117
 
# File 'step_functions_tasks/emr_add_step_json_path_props.rb', line 115

def heartbeat_timeout
  @heartbeat_timeout
end

#input_path ⇒ String? (readonly)

Note:

Default: $

JSONPath expression to select part of the state to be the input to this state.

May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.

Returns:

  • (String, nil) 


155
156
157
 
# File 'step_functions_tasks/emr_add_step_json_path_props.rb', line 155

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



125
126
127
 
# File 'step_functions_tasks/emr_add_step_json_path_props.rb', line 125

def integration_pattern
  @integration_pattern
end

#jar ⇒ String (readonly)

A path to a JAR file run during the step.

Returns:

  • (String)

See Also:



189
190
191
 
# File 'step_functions_tasks/emr_add_step_json_path_props.rb', line 189

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:



220
221
222
 
# File 'step_functions_tasks/emr_add_step_json_path_props.rb', line 220

def main_class
  @main_class
end

#name ⇒ String (readonly)

The name of the Step.

Returns:

  • (String)

See Also:



194
195
196
 
# File 'step_functions_tasks/emr_add_step_json_path_props.rb', line 194

def name
  @name
end

#output_path ⇒ String? (readonly)

Note:

Default: $

JSONPath expression to select part of the state to be the output to this state.

May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

Returns:

  • (String, nil) 


163
164
165
 
# File 'step_functions_tasks/emr_add_step_json_path_props.rb', line 163

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



228
229
230
 
# File 'step_functions_tasks/emr_add_step_json_path_props.rb', line 228

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:



88
89
90
 
# File 'step_functions_tasks/emr_add_step_json_path_props.rb', line 88

def query_language
  @query_language
end

#result_path ⇒ String? (readonly)

Note:

Default: $

JSONPath expression to indicate where to inject the state's output.

May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.

Returns:

  • (String, nil) 


171
172
173
 
# File 'step_functions_tasks/emr_add_step_json_path_props.rb', line 171

def result_path
  @result_path
end

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

Note:

Default: - None

The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.

You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.

Returns:

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

See Also:



180
181
182
 
# File 'step_functions_tasks/emr_add_step_json_path_props.rb', line 180

def result_selector
  @result_selector
end

#state_name ⇒ String? (readonly)

Note:

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

Optional name for this state.

Returns:

  • (String, nil) 


93
94
95
 
# File 'step_functions_tasks/emr_add_step_json_path_props.rb', line 93

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:



133
134
135
 
# File 'step_functions_tasks/emr_add_step_json_path_props.rb', line 133

def task_timeout
  @task_timeout
end

#timeout ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use taskTimeout

Note:

Default: - None

Timeout for the task.

Returns:



139
140
141
 
# File 'step_functions_tasks/emr_add_step_json_path_props.rb', line 139

def timeout
  @timeout
end

Class Method Details

.jsii_properties ⇒ Object 



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'step_functions_tasks/emr_add_step_json_path_props.rb', line 230

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",
    :input_path => "inputPath",
    :output_path => "outputPath",
    :result_path => "resultPath",
    :result_selector => "resultSelector",
    :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 



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'step_functions_tasks/emr_add_step_json_path_props.rb', line 257

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,
    "inputPath" => @input_path,
    "outputPath" => @output_path,
    "resultPath" => @result_path,
    "resultSelector" => @result_selector,
    "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