Class: AWSCDK::StepFunctionsTasks::CallAPIGatewayHttpAPIEndpointJsonataProps

Inherits:
CallAPIGatewayEndpointJsonataBaseProps
  • Object
show all
Defined in:
step_functions_tasks/call_api_gateway_http_api_endpoint_jsonata_props.rb

Overview

Properties for calling an HTTP API Endpoint 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, method:, api_path: nil, auth_type: nil, headers: nil, query_parameters: nil, request_body: nil, api_id:, api_stack:, stage_name: nil) ⇒ CallAPIGatewayHttpAPIEndpointJsonataProps

Returns a new instance of CallAPIGatewayHttpAPIEndpointJsonataProps.

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.

  • method (AWSCDK::StepFunctionsTasks::HttpMethod) —

    Http method for the API.

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

    Path parameters appended after API endpoint.

  • auth_type (AWSCDK::StepFunctionsTasks::AuthType, nil) (defaults to: nil) —

    Authentication methods.

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

    HTTP request information that does not relate to contents of the request.

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

    Query strings attached to end of request.

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

    HTTP Request body.

  • api_id (String) —

    The Id of the API to call.

  • api_stack (AWSCDK::Stack) —

    The Stack in which the API is defined.

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

    Name of the stage where the API is deployed to in API Gateway.



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
 
# File 'step_functions_tasks/call_api_gateway_http_api_endpoint_jsonata_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, outputs: nil, method:, api_path: nil, auth_type: nil, headers: nil, query_parameters: nil, request_body: nil, api_id:, api_stack:, stage_name: 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?
  @method = method
  Jsii::Type.check_type(@method, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9uc190YXNrcy5IdHRwTWV0aG9kIn0=")), "method")
  @api_path = api_path
  Jsii::Type.check_type(@api_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "apiPath") unless @api_path.nil?
  @auth_type = auth_type
  Jsii::Type.check_type(@auth_type, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9uc190YXNrcy5BdXRoVHlwZSJ9")), "authType") unless @auth_type.nil?
  @headers = headers
  Jsii::Type.check_type(@headers, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5UYXNrSW5wdXQifQ==")), "headers") unless @headers.nil?
  @query_parameters = query_parameters
  Jsii::Type.check_type(@query_parameters, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5UYXNrSW5wdXQifQ==")), "queryParameters") unless @query_parameters.nil?
  @request_body = request_body
  Jsii::Type.check_type(@request_body, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5UYXNrSW5wdXQifQ==")), "requestBody") unless @request_body.nil?
  @api_id = api_id
  Jsii::Type.check_type(@api_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "apiId")
  @api_stack = api_stack
  Jsii::Type.check_type(@api_stack, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5TdGFjayJ9")), "apiStack")
  @stage_name = stage_name
  Jsii::Type.check_type(@stage_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stageName") unless @stage_name.nil?
end

Instance Attribute Details

#api_id ⇒ String (readonly)

The Id of the API to call.

Returns:

  • (String) 


187
188
189
 
# File 'step_functions_tasks/call_api_gateway_http_api_endpoint_jsonata_props.rb', line 187

def api_id
  @api_id
end

#api_path ⇒ String? (readonly)

Note:

Default: - No path

Path parameters appended after API endpoint.

Returns:

  • (String, nil) 


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

def api_path
  @api_path
end

#api_stack ⇒ AWSCDK::Stack (readonly)

The Stack in which the API is defined.

Returns:



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

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



142
143
144
 
# File 'step_functions_tasks/call_api_gateway_http_api_endpoint_jsonata_props.rb', line 142

def assign
  @assign
end

#auth_type ⇒ AWSCDK::StepFunctionsTasks::AuthType? (readonly)

Note:

Default: AuthType.NO_AUTH

Authentication methods.

Returns:



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

def auth_type
  @auth_type
end

#comment ⇒ String? (readonly)

Note:

Default: No comment

A comment describing this state.

Returns:

  • (String, nil) 


75
76
77
 
# File 'step_functions_tasks/call_api_gateway_http_api_endpoint_jsonata_props.rb', line 75

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:



96
97
98
 
# File 'step_functions_tasks/call_api_gateway_http_api_endpoint_jsonata_props.rb', line 96

def credentials
  @credentials
end

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

Note:

Default: - No headers

HTTP request information that does not relate to contents of the request.

Returns:



173
174
175
 
# File 'step_functions_tasks/call_api_gateway_http_api_endpoint_jsonata_props.rb', line 173

def headers
  @headers
end

#heartbeat ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use heartbeatTimeout

Note:

Default: - None

Timeout for the heartbeat.

Returns:



102
103
104
 
# File 'step_functions_tasks/call_api_gateway_http_api_endpoint_jsonata_props.rb', line 102

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:



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

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:



120
121
122
 
# File 'step_functions_tasks/call_api_gateway_http_api_endpoint_jsonata_props.rb', line 120

def integration_pattern
  @integration_pattern
end

#method ⇒ AWSCDK::StepFunctionsTasks::HttpMethod (readonly)

Http method for the API.

Returns:



158
159
160
 
# File 'step_functions_tasks/call_api_gateway_http_api_endpoint_jsonata_props.rb', line 158

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



154
155
156
 
# File 'step_functions_tasks/call_api_gateway_http_api_endpoint_jsonata_props.rb', line 154

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:



83
84
85
 
# File 'step_functions_tasks/call_api_gateway_http_api_endpoint_jsonata_props.rb', line 83

def query_language
  @query_language
end

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

Note:

Default: - No query parameters

Query strings attached to end of request.

Returns:



178
179
180
 
# File 'step_functions_tasks/call_api_gateway_http_api_endpoint_jsonata_props.rb', line 178

def query_parameters
  @query_parameters
end

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

Note:

Default: - No request body

HTTP Request body.

Returns:



183
184
185
 
# File 'step_functions_tasks/call_api_gateway_http_api_endpoint_jsonata_props.rb', line 183

def request_body
  @request_body
end

#stage_name ⇒ String? (readonly)

Note:

Default: '$default'

Name of the stage where the API is deployed to in API Gateway.

Returns:

  • (String, nil) 


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

def stage_name
  @stage_name
end

#state_name ⇒ String? (readonly)

Note:

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

Optional name for this state.

Returns:

  • (String, nil) 


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

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:



128
129
130
 
# File 'step_functions_tasks/call_api_gateway_http_api_endpoint_jsonata_props.rb', line 128

def task_timeout
  @task_timeout
end

#timeout ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use taskTimeout

Note:

Default: - None

Timeout for the task.

Returns:



134
135
136
 
# File 'step_functions_tasks/call_api_gateway_http_api_endpoint_jsonata_props.rb', line 134

def timeout
  @timeout
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
221
 
# File 'step_functions_tasks/call_api_gateway_http_api_endpoint_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",
    :method => "method",
    :api_path => "apiPath",
    :auth_type => "authType",
    :headers => "headers",
    :query_parameters => "queryParameters",
    :request_body => "requestBody",
    :api_id => "apiId",
    :api_stack => "apiStack",
    :stage_name => "stageName",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



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
248
249
 
# File 'step_functions_tasks/call_api_gateway_http_api_endpoint_jsonata_props.rb', line 223

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,
    "method" => @method,
    "apiPath" => @api_path,
    "authType" => @auth_type,
    "headers" => @headers,
    "queryParameters" => @query_parameters,
    "requestBody" => @request_body,
    "apiId" => @api_id,
    "apiStack" => @api_stack,
    "stageName" => @stage_name,
  })
  result.compact
end