Class: AWSCDK::StepFunctionsTasks::HttpInvokeJsonPathProps

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

Overview

Properties for calling an external HTTP endpoint with HttpInvoke 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, api_endpoint:, api_root:, connection:, method:, body: nil, headers: nil, query_string_parameters: nil, url_encoding_format: nil) ⇒ HttpInvokeJsonPathProps

Returns a new instance of HttpInvokeJsonPathProps.

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.

  • api_endpoint (AWSCDK::StepFunctions::TaskInput) —

    The API endpoint to call, relative to apiRoot.

  • api_root (String) —

    Permissions are granted to call all resources under this path.

  • connection (AWSCDK::Events::IConnection) —

    The EventBridge Connection to use for authentication.

  • method (AWSCDK::StepFunctions::TaskInput) —

    The HTTP method to use.

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

    The body to send to the HTTP endpoint.

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

    The headers to send to the HTTP endpoint.

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

    The query string parameters to send to the HTTP endpoint.

  • url_encoding_format (AWSCDK::StepFunctionsTasks::URLEncodingFormat, nil) (defaults to: nil) —

    Determines whether to apply URL encoding to the request body, and which array encoding format to use.



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
72
73
74
 
# File 'step_functions_tasks/http_invoke_json_path_props.rb', line 29

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, api_endpoint:, api_root:, connection:, method:, body: nil, headers: nil, query_string_parameters: nil, url_encoding_format: 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?
  @api_endpoint = api_endpoint
  Jsii::Type.check_type(@api_endpoint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5UYXNrSW5wdXQifQ==")), "apiEndpoint")
  @api_root = api_root
  Jsii::Type.check_type(@api_root, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "apiRoot")
  @connection = connection
  Jsii::Type.check_type(@connection, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZXZlbnRzLklDb25uZWN0aW9uIn0=")), "connection")
  @method = method
  Jsii::Type.check_type(@method, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5UYXNrSW5wdXQifQ==")), "method")
  @body = body
  Jsii::Type.check_type(@body, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5UYXNrSW5wdXQifQ==")), "body") unless @body.nil?
  @headers = headers
  Jsii::Type.check_type(@headers, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5UYXNrSW5wdXQifQ==")), "headers") unless @headers.nil?
  @query_string_parameters = query_string_parameters
  Jsii::Type.check_type(@query_string_parameters, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5UYXNrSW5wdXQifQ==")), "queryStringParameters") unless @query_string_parameters.nil?
  @url_encoding_format = url_encoding_format
  Jsii::Type.check_type(@url_encoding_format, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9uc190YXNrcy5VUkxFbmNvZGluZ0Zvcm1hdCJ9")), "urlEncodingFormat") unless @url_encoding_format.nil?
end

Instance Attribute Details

#api_endpoint ⇒ AWSCDK::StepFunctions::TaskInput (readonly)

The API endpoint to call, relative to apiRoot.

Examples:

AWSCDK::StepFunctions::TaskInput.from_text("path/to/resource")

Returns:



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

def api_endpoint
  @api_endpoint
end

#api_root ⇒ String (readonly)

Permissions are granted to call all resources under this path.

Examples:

"https://api.example.com"

Returns:

  • (String) 


192
193
194
 
# File 'step_functions_tasks/http_invoke_json_path_props.rb', line 192

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



147
148
149
 
# File 'step_functions_tasks/http_invoke_json_path_props.rb', line 147

def assign
  @assign
end

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

Note:

Default: - No body is sent with the request.

The body to send to the HTTP endpoint.

Returns:



207
208
209
 
# File 'step_functions_tasks/http_invoke_json_path_props.rb', line 207

def body
  @body
end

#comment ⇒ String? (readonly)

Note:

Default: No comment

A comment describing this state.

Returns:

  • (String, nil) 


80
81
82
 
# File 'step_functions_tasks/http_invoke_json_path_props.rb', line 80

def comment
  @comment
end

#connection ⇒ AWSCDK::Events::IConnection (readonly)

The EventBridge Connection to use for authentication.

Returns:



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

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



101
102
103
 
# File 'step_functions_tasks/http_invoke_json_path_props.rb', line 101

def credentials
  @credentials
end

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

Note:

Default: - No additional headers are added to the request.

The headers to send to the HTTP endpoint.

Examples:

AWSCDK::StepFunctions::TaskInput.from_object({"Content-Type" => "application/json"})

Returns:



214
215
216
 
# File 'step_functions_tasks/http_invoke_json_path_props.rb', line 214

def headers
  @headers
end

#heartbeat ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use heartbeatTimeout

Note:

Default: - None

Timeout for the heartbeat.

Returns:



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

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:



115
116
117
 
# File 'step_functions_tasks/http_invoke_json_path_props.rb', line 115

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) 


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

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:



125
126
127
 
# File 'step_functions_tasks/http_invoke_json_path_props.rb', line 125

def integration_pattern
  @integration_pattern
end

#method ⇒ AWSCDK::StepFunctions::TaskInput (readonly)

The HTTP method to use.

Examples:

AWSCDK::StepFunctions::TaskInput.from_text("GET")

Returns:



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

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


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

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



88
89
90
 
# File 'step_functions_tasks/http_invoke_json_path_props.rb', line 88

def query_language
  @query_language
end

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

Note:

Default: - No query string parameters are sent in the request.

The query string parameters to send to the HTTP endpoint.

Returns:



219
220
221
 
# File 'step_functions_tasks/http_invoke_json_path_props.rb', line 219

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


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

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:



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

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) 


93
94
95
 
# File 'step_functions_tasks/http_invoke_json_path_props.rb', line 93

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:



133
134
135
 
# File 'step_functions_tasks/http_invoke_json_path_props.rb', line 133

def task_timeout
  @task_timeout
end

#timeout ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use taskTimeout

Note:

Default: - None

Timeout for the task.

Returns:



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

def timeout
  @timeout
end

#url_encoding_format ⇒ AWSCDK::StepFunctionsTasks::URLEncodingFormat? (readonly)

Note:

Default: - URLEncodingFormat.NONE

Determines whether to apply URL encoding to the request body, and which array encoding format to use.

URLEncodingFormat.NONE passes the JSON-serialized RequestBody field as the HTTP request body. Otherwise, the HTTP request body is the URL-encoded form data of the RequestBody field using the specified array encoding format, and the Content-Type header is set to application/x-www-form-urlencoded.

Returns:



228
229
230
 
# File 'step_functions_tasks/http_invoke_json_path_props.rb', line 228

def url_encoding_format
  @url_encoding_format
end

Class Method Details

.jsii_properties ⇒ Object 



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

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",
    :api_endpoint => "apiEndpoint",
    :api_root => "apiRoot",
    :connection => "connection",
    :method => "method",
    :body => "body",
    :headers => "headers",
    :query_string_parameters => "queryStringParameters",
    :url_encoding_format => "urlEncodingFormat",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



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
284
285
 
# File 'step_functions_tasks/http_invoke_json_path_props.rb', line 257

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,
    "apiEndpoint" => @api_endpoint,
    "apiRoot" => @api_root,
    "connection" => @connection,
    "method" => @method,
    "body" => @body,
    "headers" => @headers,
    "queryStringParameters" => @query_string_parameters,
    "urlEncodingFormat" => @url_encoding_format,
  })
  result.compact
end