Class: AWSCDK::StepFunctionsTasks::EMRContainersStartJobRunJsonataProps

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

Overview

Properties for calling EMR Containers StartJobRun 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, job_driver:, release_label:, virtual_cluster:, application_config: nil, execution_role: nil, job_name: nil, monitoring: nil, tags: nil) ⇒ EMRContainersStartJobRunJsonataProps

Returns a new instance of EMRContainersStartJobRunJsonataProps.

Parameters:



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_containers_start_job_run_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, 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?
  @outputs = outputs
  Jsii::Type.check_type(@outputs, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "outputs") unless @outputs.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:



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

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:



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

def assign
  @assign
end

#comment ⇒ String? (readonly)

Note:

Default: No comment

A comment describing this state.

Returns:

  • (String, nil) 


71
72
73
 
# File 'step_functions_tasks/emr_containers_start_job_run_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_containers_start_job_run_jsonata_props.rb', line 92

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:



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

def execution_role
  @execution_role
end

#heartbeat ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use heartbeatTimeout

Note:

Default: - None

Timeout for the heartbeat.

Returns:



98
99
100
 
# File 'step_functions_tasks/emr_containers_start_job_run_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_containers_start_job_run_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_containers_start_job_run_jsonata_props.rb', line 116

def integration_pattern
  @integration_pattern
end

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

The job driver for the job run.

Returns:

See Also:



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

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) 


185
186
187
 
# File 'step_functions_tasks/emr_containers_start_job_run_jsonata_props.rb', line 185

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:



191
192
193
 
# File 'step_functions_tasks/emr_containers_start_job_run_jsonata_props.rb', line 191

def monitoring
  @monitoring
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_containers_start_job_run_jsonata_props.rb', line 150

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:



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

def query_language
  @query_language
end

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

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

Returns:



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

def release_label
  @release_label
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_containers_start_job_run_jsonata_props.rb', line 84

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) 


196
197
198
 
# File 'step_functions_tasks/emr_containers_start_job_run_jsonata_props.rb', line 196

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:



124
125
126
 
# File 'step_functions_tasks/emr_containers_start_job_run_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_containers_start_job_run_jsonata_props.rb', line 130

def timeout
  @timeout
end

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

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

Returns:



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

def virtual_cluster
  @virtual_cluster
end

Class Method Details

.jsii_properties ⇒ Object 



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

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",
    :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 



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

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,
    "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