Class: AWSCDK::StepFunctionsTasks::EMRContainersStartJobRunProps

Inherits:
AWSCDK::StepFunctions::TaskStateBaseProps
  • Object
show all
Defined in:
step_functions_tasks/emr_containers_start_job_run_props.rb

Overview

The props for a EMR Containers StartJobRun Task.

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, outputs: nil, result_path: nil, result_selector: nil, job_driver:, release_label:, virtual_cluster:, application_config: nil, execution_role: nil, job_name: nil, monitoring: nil, tags: nil) ⇒ EMRContainersStartJobRunProps

Returns a new instance of EMRContainersStartJobRunProps.

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.

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

    Used to specify and transform output from the 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.

  • job_driver (AWSCDK::StepFunctionsTasks::JobDriver) —

    The job driver for the job run.

  • release_label (AWSCDK::StepFunctionsTasks::ReleaseLabel) —

    The Amazon EMR release version to use for the job run.

  • virtual_cluster (AWSCDK::StepFunctionsTasks::VirtualClusterInput) —

    The ID of the virtual cluster where the job will be run.

  • application_config (Array<AWSCDK::StepFunctionsTasks::ApplicationConfiguration>, nil) (defaults to: nil) —

    The configurations for the application running in the job run.

  • execution_role (AWSCDK::IAM::IRole, nil) (defaults to: nil) —

    The execution role for the job run.

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

    The name of the job run.

  • monitoring (AWSCDK::StepFunctionsTasks::Monitoring, nil) (defaults to: nil) —

    Configuration for monitoring the job run.

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

    The tags assigned to job runs.



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
75
76
77
 
# File 'step_functions_tasks/emr_containers_start_job_run_props.rb', line 30

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, outputs: nil, result_path: nil, result_selector: nil, job_driver:, release_label:, virtual_cluster:, application_config: nil, execution_role: nil, job_name: nil, monitoring: nil, tags: 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?
  @outputs = outputs
  Jsii::Type.check_type(@outputs, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "outputs") unless @outputs.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?
  @job_driver = job_driver.is_a?(Hash) ? ::AWSCDK::StepFunctionsTasks::JobDriver.new(**job_driver.transform_keys(&:to_sym)) : job_driver
  Jsii::Type.check_type(@job_driver, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9uc190YXNrcy5Kb2JEcml2ZXIifQ==")), "jobDriver")
  @release_label = release_label
  Jsii::Type.check_type(@release_label, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9uc190YXNrcy5SZWxlYXNlTGFiZWwifQ==")), "releaseLabel")
  @virtual_cluster = virtual_cluster
  Jsii::Type.check_type(@virtual_cluster, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9uc190YXNrcy5WaXJ0dWFsQ2x1c3RlcklucHV0In0=")), "virtualCluster")
  @application_config = application_config.is_a?(Array) ? application_config.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::StepFunctionsTasks::ApplicationConfiguration.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : application_config
  Jsii::Type.check_type(@application_config, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zdGVwZnVuY3Rpb25zX3Rhc2tzLkFwcGxpY2F0aW9uQ29uZmlndXJhdGlvbiJ9LCJraW5kIjoiYXJyYXkifX0=")), "applicationConfig") unless @application_config.nil?
  @execution_role = execution_role
  Jsii::Type.check_type(@execution_role, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklSb2xlIn0=")), "executionRole") unless @execution_role.nil?
  @job_name = job_name
  Jsii::Type.check_type(@job_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "jobName") unless @job_name.nil?
  @monitoring = monitoring.is_a?(Hash) ? ::AWSCDK::StepFunctionsTasks::Monitoring.new(**monitoring.transform_keys(&:to_sym)) : monitoring
  Jsii::Type.check_type(@monitoring, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9uc190YXNrcy5Nb25pdG9yaW5nIn0=")), "monitoring") unless @monitoring.nil?
  @tags = tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "tags") unless @tags.nil?
end

Instance Attribute Details

#application_config ⇒ Array<AWSCDK::StepFunctionsTasks::ApplicationConfiguration>? (readonly)

Note:

Default: - No application config

The configurations for the application running in the job run.

Maximum of 100 items

Returns:

See Also:



216
217
218
 
# File 'step_functions_tasks/emr_containers_start_job_run_props.rb', line 216

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



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

def assign
  @assign
end

#comment ⇒ String? (readonly)

Note:

Default: No comment

A comment describing this state.

Returns:

  • (String, nil) 


83
84
85
 
# File 'step_functions_tasks/emr_containers_start_job_run_props.rb', line 83

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:



104
105
106
 
# File 'step_functions_tasks/emr_containers_start_job_run_props.rb', line 104

def credentials
  @credentials
end

#execution_role ⇒ AWSCDK::IAM::IRole? (readonly)

Note:

Default: - Automatically generated only when the provided virtualClusterId is not an encoded JSON path

The execution role for the job run.

If virtual_cluster_id is from a JSON input path, an execution role must be provided. If an execution role is provided, follow the documentation to update the role trust policy.

Returns:

See Also:



225
226
227
 
# File 'step_functions_tasks/emr_containers_start_job_run_props.rb', line 225

def execution_role
  @execution_role
end

#heartbeat ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use heartbeatTimeout

Note:

Default: - None

Timeout for the heartbeat.

Returns:



110
111
112
 
# File 'step_functions_tasks/emr_containers_start_job_run_props.rb', line 110

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:



118
119
120
 
# File 'step_functions_tasks/emr_containers_start_job_run_props.rb', line 118

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) 


158
159
160
 
# File 'step_functions_tasks/emr_containers_start_job_run_props.rb', line 158

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:



128
129
130
 
# File 'step_functions_tasks/emr_containers_start_job_run_props.rb', line 128

def integration_pattern
  @integration_pattern
end

#job_driver ⇒ AWSCDK::StepFunctionsTasks::JobDriver (readonly)

The job driver for the job run.

Returns:

See Also:



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

def job_driver
  @job_driver
end

#job_name ⇒ String? (readonly)

Note:

Default: - No job run name

The name of the job run.

Returns:

  • (String, nil) 


230
231
232
 
# File 'step_functions_tasks/emr_containers_start_job_run_props.rb', line 230

def job_name
  @job_name
end

#monitoring ⇒ AWSCDK::StepFunctionsTasks::Monitoring? (readonly)

Note:

Default: - logging enabled and resources automatically generated if monitoring.logging is set to true

Configuration for monitoring the job run.

Returns:

See Also:



236
237
238
 
# File 'step_functions_tasks/emr_containers_start_job_run_props.rb', line 236

def monitoring
  @monitoring
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) 


166
167
168
 
# File 'step_functions_tasks/emr_containers_start_job_run_props.rb', line 166

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



178
179
180
 
# File 'step_functions_tasks/emr_containers_start_job_run_props.rb', line 178

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:



91
92
93
 
# File 'step_functions_tasks/emr_containers_start_job_run_props.rb', line 91

def query_language
  @query_language
end

#release_label ⇒ AWSCDK::StepFunctionsTasks::ReleaseLabel (readonly)

The Amazon EMR release version to use for the job run.

Returns:



204
205
206
 
# File 'step_functions_tasks/emr_containers_start_job_run_props.rb', line 204

def release_label
  @release_label
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) 


186
187
188
 
# File 'step_functions_tasks/emr_containers_start_job_run_props.rb', line 186

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:



195
196
197
 
# File 'step_functions_tasks/emr_containers_start_job_run_props.rb', line 195

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) 


96
97
98
 
# File 'step_functions_tasks/emr_containers_start_job_run_props.rb', line 96

def state_name
  @state_name
end

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

Note:

Default: - None

The tags assigned to job runs.

Returns:

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


241
242
243
 
# File 'step_functions_tasks/emr_containers_start_job_run_props.rb', line 241

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



136
137
138
 
# File 'step_functions_tasks/emr_containers_start_job_run_props.rb', line 136

def task_timeout
  @task_timeout
end

#timeout ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use taskTimeout

Note:

Default: - None

Timeout for the task.

Returns:



142
143
144
 
# File 'step_functions_tasks/emr_containers_start_job_run_props.rb', line 142

def timeout
  @timeout
end

#virtual_cluster ⇒ AWSCDK::StepFunctionsTasks::VirtualClusterInput (readonly)

The ID of the virtual cluster where the job will be run.

Returns:



208
209
210
 
# File 'step_functions_tasks/emr_containers_start_job_run_props.rb', line 208

def virtual_cluster
  @virtual_cluster
end

Class Method Details

.jsii_properties ⇒ Object 



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'step_functions_tasks/emr_containers_start_job_run_props.rb', line 243

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",
    :outputs => "outputs",
    :result_path => "resultPath",
    :result_selector => "resultSelector",
    :job_driver => "jobDriver",
    :release_label => "releaseLabel",
    :virtual_cluster => "virtualCluster",
    :application_config => "applicationConfig",
    :execution_role => "executionRole",
    :job_name => "jobName",
    :monitoring => "monitoring",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'step_functions_tasks/emr_containers_start_job_run_props.rb', line 271

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,
    "outputs" => @outputs,
    "resultPath" => @result_path,
    "resultSelector" => @result_selector,
    "jobDriver" => @job_driver,
    "releaseLabel" => @release_label,
    "virtualCluster" => @virtual_cluster,
    "applicationConfig" => @application_config,
    "executionRole" => @execution_role,
    "jobName" => @job_name,
    "monitoring" => @monitoring,
    "tags" => @tags,
  })
  result.compact
end