Class: AWSCDK::StepFunctionsTasks::GlueStartJobRunJsonataProps

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

Overview

Properties for starting an AWS Glue job as a 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, outputs: nil, glue_job_name:, arguments: nil, execution_class: nil, notify_delay_after: nil, security_configuration: nil, worker_configuration: nil) ⇒ GlueStartJobRunJsonataProps

Returns a new instance of GlueStartJobRunJsonataProps.

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.

  • glue_job_name (String) —

    Glue job name.

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

    The job arguments specifically for this run.

  • execution_class (AWSCDK::StepFunctionsTasks::ExecutionClass, nil) (defaults to: nil) —

    The excecution class of the job.

  • notify_delay_after (AWSCDK::Duration, nil) (defaults to: nil) —

    After a job run starts, the number of minutes to wait before sending a job run delay notification.

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

    The name of the SecurityConfiguration structure to be used with this job run.

  • worker_configuration (AWSCDK::StepFunctionsTasks::WorkerConfigurationProperty, nil) (defaults to: nil) —

    The worker configuration for this run.



24
25
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
 
# File 'step_functions_tasks/glue_start_job_run_jsonata_props.rb', line 24

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, glue_job_name:, arguments: nil, execution_class: nil, notify_delay_after: nil, security_configuration: nil, worker_configuration: 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?
  @glue_job_name = glue_job_name
  Jsii::Type.check_type(@glue_job_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "glueJobName")
  @arguments = arguments
  Jsii::Type.check_type(@arguments, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5UYXNrSW5wdXQifQ==")), "arguments") unless @arguments.nil?
  @execution_class = execution_class
  Jsii::Type.check_type(@execution_class, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9uc190YXNrcy5FeGVjdXRpb25DbGFzcyJ9")), "executionClass") unless @execution_class.nil?
  @notify_delay_after = notify_delay_after
  Jsii::Type.check_type(@notify_delay_after, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5EdXJhdGlvbiJ9")), "notifyDelayAfter") unless @notify_delay_after.nil?
  @security_configuration = security_configuration
  Jsii::Type.check_type(@security_configuration, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "securityConfiguration") unless @security_configuration.nil?
  @worker_configuration = worker_configuration.is_a?(Hash) ? ::AWSCDK::StepFunctionsTasks::WorkerConfigurationProperty.new(**worker_configuration.transform_keys(&:to_sym)) : worker_configuration
  Jsii::Type.check_type(@worker_configuration, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9uc190YXNrcy5Xb3JrZXJDb25maWd1cmF0aW9uUHJvcGVydHkifQ==")), "workerConfiguration") unless @worker_configuration.nil?
end

Instance Attribute Details

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

Note:

Default: - Default arguments set in the job definition

The job arguments specifically for this run.

For this job run, they replace the default arguments set in the job definition itself.

Returns:



156
157
158
 
# File 'step_functions_tasks/glue_start_job_run_jsonata_props.rb', line 156

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



132
133
134
 
# File 'step_functions_tasks/glue_start_job_run_jsonata_props.rb', line 132

def assign
  @assign
end

#comment ⇒ String? (readonly)

Note:

Default: No comment

A comment describing this state.

Returns:

  • (String, nil) 


65
66
67
 
# File 'step_functions_tasks/glue_start_job_run_jsonata_props.rb', line 65

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:



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

def credentials
  @credentials
end

#execution_class ⇒ AWSCDK::StepFunctionsTasks::ExecutionClass? (readonly)

Note:

Default: - STANDARD

The excecution class of the job.

Returns:



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

def execution_class
  @execution_class
end

#glue_job_name ⇒ String (readonly)

Glue job name.

Returns:

  • (String) 


148
149
150
 
# File 'step_functions_tasks/glue_start_job_run_jsonata_props.rb', line 148

def glue_job_name
  @glue_job_name
end

#heartbeat ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use heartbeatTimeout

Note:

Default: - None

Timeout for the heartbeat.

Returns:



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

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:



100
101
102
 
# File 'step_functions_tasks/glue_start_job_run_jsonata_props.rb', line 100

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:



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

def integration_pattern
  @integration_pattern
end

#notify_delay_after ⇒ AWSCDK::Duration? (readonly)

Note:

Default: - Default delay set in the job definition

After a job run starts, the number of minutes to wait before sending a job run delay notification.

Must be at least 1 minute.

Returns:



168
169
170
 
# File 'step_functions_tasks/glue_start_job_run_jsonata_props.rb', line 168

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



144
145
146
 
# File 'step_functions_tasks/glue_start_job_run_jsonata_props.rb', line 144

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:



73
74
75
 
# File 'step_functions_tasks/glue_start_job_run_jsonata_props.rb', line 73

def query_language
  @query_language
end

#security_configuration ⇒ String? (readonly)

Note:

Default: - Default configuration set in the job definition

The name of the SecurityConfiguration structure to be used with this job run.

This must match the Glue API

Returns:

  • (String, nil)

See Also:



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

def security_configuration
  @security_configuration
end

#state_name ⇒ String? (readonly)

Note:

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

Optional name for this state.

Returns:

  • (String, nil) 


78
79
80
 
# File 'step_functions_tasks/glue_start_job_run_jsonata_props.rb', line 78

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:



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

def task_timeout
  @task_timeout
end

#timeout ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use taskTimeout

Note:

Default: - None

Timeout for the task.

Returns:



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

def timeout
  @timeout
end

#worker_configuration ⇒ AWSCDK::StepFunctionsTasks::WorkerConfigurationProperty? (readonly)

Note:

Default: - Default worker configuration in the job definition

The worker configuration for this run.

Returns:



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

def worker_configuration
  @worker_configuration
end

Class Method Details

.jsii_properties ⇒ Object 



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'step_functions_tasks/glue_start_job_run_jsonata_props.rb', line 183

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",
    :glue_job_name => "glueJobName",
    :arguments => "arguments",
    :execution_class => "executionClass",
    :notify_delay_after => "notifyDelayAfter",
    :security_configuration => "securityConfiguration",
    :worker_configuration => "workerConfiguration",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'step_functions_tasks/glue_start_job_run_jsonata_props.rb', line 205

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,
    "glueJobName" => @glue_job_name,
    "arguments" => @arguments,
    "executionClass" => @execution_class,
    "notifyDelayAfter" => @notify_delay_after,
    "securityConfiguration" => @security_configuration,
    "workerConfiguration" => @worker_configuration,
  })
  result.compact
end