Class: AWSCDK::StepFunctionsTasks::LambdaInvokeJsonPathProps

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

Overview

Properties for invoking a Lambda function with LambdaInvoke 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, lambda_function:, client_context: nil, invocation_type: nil, payload: nil, payload_response_only: nil, qualifier: nil, retry_on_service_exceptions: nil) ⇒ LambdaInvokeJsonPathProps

Returns a new instance of LambdaInvokeJsonPathProps.

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.

  • lambda_function (AWSCDK::Lambda::IFunction) —

    Lambda function to invoke.

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

    Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function.

  • invocation_type (AWSCDK::StepFunctionsTasks::LambdaInvocationType, nil) (defaults to: nil) —

    Invocation type of the Lambda function.

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

    The JSON that will be supplied as input to the Lambda function.

  • payload_response_only (Boolean, nil) (defaults to: nil) —

    Invoke the Lambda in a way that only returns the payload response without additional metadata.

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

    Version or alias to invoke a published version of the function.

  • retry_on_service_exceptions (Boolean, nil) (defaults to: nil) —

    Whether to retry on Lambda service exceptions.



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
66
67
68
69
70
71
 
# File 'step_functions_tasks/lambda_invoke_json_path_props.rb', line 28

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, lambda_function:, client_context: nil, invocation_type: nil, payload: nil, payload_response_only: nil, qualifier: nil, retry_on_service_exceptions: 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?
  @lambda_function = lambda_function
  Jsii::Type.check_type(@lambda_function, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbGFtYmRhLklGdW5jdGlvbiJ9")), "lambdaFunction")
  @client_context = client_context
  Jsii::Type.check_type(@client_context, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clientContext") unless @client_context.nil?
  @invocation_type = invocation_type
  Jsii::Type.check_type(@invocation_type, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9uc190YXNrcy5MYW1iZGFJbnZvY2F0aW9uVHlwZSJ9")), "invocationType") unless @invocation_type.nil?
  @payload = payload
  Jsii::Type.check_type(@payload, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5UYXNrSW5wdXQifQ==")), "payload") unless @payload.nil?
  @payload_response_only = payload_response_only
  Jsii::Type.check_type(@payload_response_only, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "payloadResponseOnly") unless @payload_response_only.nil?
  @qualifier = qualifier
  Jsii::Type.check_type(@qualifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "qualifier") unless @qualifier.nil?
  @retry_on_service_exceptions = retry_on_service_exceptions
  Jsii::Type.check_type(@retry_on_service_exceptions, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "retryOnServiceExceptions") unless @retry_on_service_exceptions.nil?
end

Instance Attribute Details

#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:



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

def assign
  @assign
end

#client_context ⇒ String? (readonly)

Note:

Default: - No context

Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function.

Returns:

  • (String, nil) 


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

def client_context
  @client_context
end

#comment ⇒ String? (readonly)

Note:

Default: No comment

A comment describing this state.

Returns:

  • (String, nil) 


77
78
79
 
# File 'step_functions_tasks/lambda_invoke_json_path_props.rb', line 77

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:



98
99
100
 
# File 'step_functions_tasks/lambda_invoke_json_path_props.rb', line 98

def credentials
  @credentials
end

#heartbeat ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use heartbeatTimeout

Note:

Default: - None

Timeout for the heartbeat.

Returns:



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

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:



112
113
114
 
# File 'step_functions_tasks/lambda_invoke_json_path_props.rb', line 112

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) 


152
153
154
 
# File 'step_functions_tasks/lambda_invoke_json_path_props.rb', line 152

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:



122
123
124
 
# File 'step_functions_tasks/lambda_invoke_json_path_props.rb', line 122

def integration_pattern
  @integration_pattern
end

#invocation_type ⇒ AWSCDK::StepFunctionsTasks::LambdaInvocationType? (readonly)

Note:

Default: InvocationType.REQUEST_RESPONSE

Invocation type of the Lambda function.

Returns:



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

def invocation_type
  @invocation_type
end

#lambda_function ⇒ AWSCDK::Lambda::IFunction (readonly)

Lambda function to invoke.

Returns:



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

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


160
161
162
 
# File 'step_functions_tasks/lambda_invoke_json_path_props.rb', line 160

def output_path
  @output_path
end

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

Note:

Default: - The state input (JSONata: '$states.input %', JSONPath: '$')

The JSON that will be supplied as input to the Lambda function.

Returns:



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

def payload
  @payload
end

#payload_response_only ⇒ Boolean? (readonly)

Note:

Default: false

Invoke the Lambda in a way that only returns the payload response without additional metadata.

The payload_response_only property cannot be used if integration_pattern, invocation_type, client_context, or qualifier are specified. It always uses the REQUEST_RESPONSE behavior.

Returns:

  • (Boolean, nil) 


205
206
207
 
# File 'step_functions_tasks/lambda_invoke_json_path_props.rb', line 205

def payload_response_only
  @payload_response_only
end

#qualifier ⇒ String? (readonly)

Deprecated.

pass a Version or Alias object as lambdaFunction instead

Note:

Default: - Version or alias inherent to the lambdaFunction object.

Version or alias to invoke a published version of the function.

You only need to supply this if you want the version of the Lambda Function to depend on data in the state machine state. If not, you can pass the appropriate Alias or Version object directly as the lambda_function argument.

Returns:

  • (String, nil) 


215
216
217
 
# File 'step_functions_tasks/lambda_invoke_json_path_props.rb', line 215

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



85
86
87
 
# File 'step_functions_tasks/lambda_invoke_json_path_props.rb', line 85

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) 


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

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:



177
178
179
 
# File 'step_functions_tasks/lambda_invoke_json_path_props.rb', line 177

def result_selector
  @result_selector
end

#retry_on_service_exceptions ⇒ Boolean? (readonly)

Note:

Default: true

Whether to retry on Lambda service exceptions.

This handles Lambda.ServiceException, Lambda.AWSLambdaException, Lambda.SdkClientException, and Lambda.ClientExecutionTimeoutException with an interval of 2 seconds, a back-off rate of 2 and 6 maximum attempts.

Returns:

  • (Boolean, nil)

See Also:



226
227
228
 
# File 'step_functions_tasks/lambda_invoke_json_path_props.rb', line 226

def retry_on_service_exceptions
  @retry_on_service_exceptions
end

#state_name ⇒ String? (readonly)

Note:

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

Optional name for this state.

Returns:

  • (String, nil) 


90
91
92
 
# File 'step_functions_tasks/lambda_invoke_json_path_props.rb', line 90

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:



130
131
132
 
# File 'step_functions_tasks/lambda_invoke_json_path_props.rb', line 130

def task_timeout
  @task_timeout
end

#timeout ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use taskTimeout

Note:

Default: - None

Timeout for the task.

Returns:



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

def timeout
  @timeout
end

Class Method Details

.jsii_properties ⇒ Object 



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

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",
    :lambda_function => "lambdaFunction",
    :client_context => "clientContext",
    :invocation_type => "invocationType",
    :payload => "payload",
    :payload_response_only => "payloadResponseOnly",
    :qualifier => "qualifier",
    :retry_on_service_exceptions => "retryOnServiceExceptions",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



254
255
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
 
# File 'step_functions_tasks/lambda_invoke_json_path_props.rb', line 254

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,
    "lambdaFunction" => @lambda_function,
    "clientContext" => @client_context,
    "invocationType" => @invocation_type,
    "payload" => @payload,
    "payloadResponseOnly" => @payload_response_only,
    "qualifier" => @qualifier,
    "retryOnServiceExceptions" => @retry_on_service_exceptions,
  })
  result.compact
end