Class: AWSCDK::StepFunctionsTasks::BatchSubmitJobProps

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

Overview

Properties for BatchSubmitJob.

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_definition_arn:, job_name:, job_queue_arn:, array_size: nil, attempts: nil, container_overrides: nil, depends_on: nil, payload: nil, tags: nil) ⇒ BatchSubmitJobProps

Returns a new instance of BatchSubmitJobProps.

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_definition_arn (String) —

    The arn of the job definition used by this job.

  • job_name (String) —

    The name of the job.

  • job_queue_arn (String) —

    The arn of the job queue into which the job is submitted.

  • array_size (Numeric, nil) (defaults to: nil) —

    The array size can be between 2 and 10,000.

  • attempts (Numeric, nil) (defaults to: nil) —

    The number of times to move a job to the RUNNABLE status.

  • container_overrides (AWSCDK::StepFunctionsTasks::BatchContainerOverrides, nil) (defaults to: nil) —

    A list of container overrides in JSON format that specify the name of a container in the specified job definition and the overrides it should receive.

  • depends_on (Array<AWSCDK::StepFunctionsTasks::BatchJobDependency>, nil) (defaults to: nil) —

    A list of dependencies for the job.

  • payload (AWSCDK::StepFunctions::TaskInput, nil) (defaults to: nil) —

    The payload to be passed as parameters to the batch job.

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

    The tags applied to the job request.



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
78
79
80
 
# File 'step_functions_tasks/batch_submit_job_props.rb', line 31

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_definition_arn:, job_name:, job_queue_arn:, array_size: nil, attempts: nil, container_overrides: nil, depends_on: nil, payload: 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_definition_arn = job_definition_arn
  Jsii::Type.check_type(@job_definition_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "jobDefinitionArn")
  @job_name = job_name
  Jsii::Type.check_type(@job_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "jobName")
  @job_queue_arn = job_queue_arn
  Jsii::Type.check_type(@job_queue_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "jobQueueArn")
  @array_size = array_size
  Jsii::Type.check_type(@array_size, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "arraySize") unless @array_size.nil?
  @attempts = attempts
  Jsii::Type.check_type(@attempts, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "attempts") unless @attempts.nil?
  @container_overrides = container_overrides.is_a?(Hash) ? ::AWSCDK::StepFunctionsTasks::BatchContainerOverrides.new(**container_overrides.transform_keys(&:to_sym)) : container_overrides
  Jsii::Type.check_type(@container_overrides, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9uc190YXNrcy5CYXRjaENvbnRhaW5lck92ZXJyaWRlcyJ9")), "containerOverrides") unless @container_overrides.nil?
  @depends_on = depends_on.is_a?(Array) ? depends_on.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::StepFunctionsTasks::BatchJobDependency.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : depends_on
  Jsii::Type.check_type(@depends_on, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zdGVwZnVuY3Rpb25zX3Rhc2tzLkJhdGNoSm9iRGVwZW5kZW5jeSJ9LCJraW5kIjoiYXJyYXkifX0=")), "dependsOn") unless @depends_on.nil?
  @payload = payload
  Jsii::Type.check_type(@payload, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5UYXNrSW5wdXQifQ==")), "payload") unless @payload.nil?
  @tags = tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "tags") unless @tags.nil?
end

Instance Attribute Details

#array_size ⇒ Numeric? (readonly)

Note:

Default: - No array size

The array size can be between 2 and 10,000.

If you specify array properties for a job, it becomes an array job. For more information, see Array Jobs in the AWS Batch User Guide.

Returns:

  • (Numeric, nil) 


221
222
223
 
# File 'step_functions_tasks/batch_submit_job_props.rb', line 221

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



153
154
155
 
# File 'step_functions_tasks/batch_submit_job_props.rb', line 153

def assign
  @assign
end

#attempts ⇒ Numeric? (readonly)

Note:

Default: 1

The number of times to move a job to the RUNNABLE status.

You may specify between 1 and 10 attempts. If the value of attempts is greater than one, the job is retried on failure the same number of attempts as the value.

Returns:

  • (Numeric, nil) 


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

def attempts
  @attempts
end

#comment ⇒ String? (readonly)

Note:

Default: No comment

A comment describing this state.

Returns:

  • (String, nil) 


86
87
88
 
# File 'step_functions_tasks/batch_submit_job_props.rb', line 86

def comment
  @comment
end

#container_overrides ⇒ AWSCDK::StepFunctionsTasks::BatchContainerOverrides? (readonly)

Note:

Default: - No container overrides

A list of container overrides in JSON format that specify the name of a container in the specified job definition and the overrides it should receive.

Returns:

See Also:



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

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



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

def credentials
  @credentials
end

#depends_on ⇒ Array<AWSCDK::StepFunctionsTasks::BatchJobDependency>? (readonly)

Note:

Default: - No dependencies

A list of dependencies for the job.

A job can depend upon a maximum of 20 jobs.

Returns:

See Also:



244
245
246
 
# File 'step_functions_tasks/batch_submit_job_props.rb', line 244

def depends_on
  @depends_on
end

#heartbeat ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use heartbeatTimeout

Note:

Default: - None

Timeout for the heartbeat.

Returns:



113
114
115
 
# File 'step_functions_tasks/batch_submit_job_props.rb', line 113

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:



121
122
123
 
# File 'step_functions_tasks/batch_submit_job_props.rb', line 121

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) 


161
162
163
 
# File 'step_functions_tasks/batch_submit_job_props.rb', line 161

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:



131
132
133
 
# File 'step_functions_tasks/batch_submit_job_props.rb', line 131

def integration_pattern
  @integration_pattern
end

#job_definition_arn ⇒ String (readonly)

The arn of the job definition used by this job.

Returns:

  • (String) 


202
203
204
 
# File 'step_functions_tasks/batch_submit_job_props.rb', line 202

def job_definition_arn
  @job_definition_arn
end

#job_name ⇒ String (readonly)

The name of the job.

The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Returns:

  • (String) 


209
210
211
 
# File 'step_functions_tasks/batch_submit_job_props.rb', line 209

def job_name
  @job_name
end

#job_queue_arn ⇒ String (readonly)

The arn of the job queue into which the job is submitted.

Returns:

  • (String) 


213
214
215
 
# File 'step_functions_tasks/batch_submit_job_props.rb', line 213

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


169
170
171
 
# File 'step_functions_tasks/batch_submit_job_props.rb', line 169

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:



181
182
183
 
# File 'step_functions_tasks/batch_submit_job_props.rb', line 181

def outputs
  @outputs
end

#payload ⇒ AWSCDK::StepFunctions::TaskInput? (readonly)

Note:

Default: - No parameters are passed

The payload to be passed as parameters to the batch job.

Returns:



249
250
251
 
# File 'step_functions_tasks/batch_submit_job_props.rb', line 249

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



94
95
96
 
# File 'step_functions_tasks/batch_submit_job_props.rb', line 94

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) 


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

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:



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

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) 


99
100
101
 
# File 'step_functions_tasks/batch_submit_job_props.rb', line 99

def state_name
  @state_name
end

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

Note:

Default: {} - no tags

The tags applied to the job request.

Returns:

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


254
255
256
 
# File 'step_functions_tasks/batch_submit_job_props.rb', line 254

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:



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

def task_timeout
  @task_timeout
end

#timeout ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use taskTimeout

Note:

Default: - None

Timeout for the task.

Returns:



145
146
147
 
# File 'step_functions_tasks/batch_submit_job_props.rb', line 145

def timeout
  @timeout
end

Class Method Details

.jsii_properties ⇒ Object 



256
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
 
# File 'step_functions_tasks/batch_submit_job_props.rb', line 256

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_definition_arn => "jobDefinitionArn",
    :job_name => "jobName",
    :job_queue_arn => "jobQueueArn",
    :array_size => "arraySize",
    :attempts => "attempts",
    :container_overrides => "containerOverrides",
    :depends_on => "dependsOn",
    :payload => "payload",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'step_functions_tasks/batch_submit_job_props.rb', line 285

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,
    "jobDefinitionArn" => @job_definition_arn,
    "jobName" => @job_name,
    "jobQueueArn" => @job_queue_arn,
    "arraySize" => @array_size,
    "attempts" => @attempts,
    "containerOverrides" => @container_overrides,
    "dependsOn" => @depends_on,
    "payload" => @payload,
    "tags" => @tags,
  })
  result.compact
end