Class: AWSCDK::StepFunctionsTasks::CallAPIGatewayRestAPIEndpointProps

Inherits:
CallAPIGatewayEndpointBaseProps
  • Object
show all
Defined in:
step_functions_tasks/call_api_gateway_rest_api_endpoint_props.rb

Overview

Properties for calling an REST API Endpoint.

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, method:, api_path: nil, auth_type: nil, headers: nil, query_parameters: nil, request_body: nil, api:, stage_name:, region: nil) ⇒ CallAPIGatewayRestAPIEndpointProps

Returns a new instance of CallAPIGatewayRestAPIEndpointProps.

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.

  • 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 (AWSCDK::APIGateway::IRestAPI) —

    API to call.

  • stage_name (String) —

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

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

    Specify a custom Region where the API is deployed, e.g. 'us-east-1'.



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
81
 
# File 'step_functions_tasks/call_api_gateway_rest_api_endpoint_props.rb', line 32

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, method:, api_path: nil, auth_type: nil, headers: nil, query_parameters: nil, request_body: nil, api:, stage_name:, region: 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?
  @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 = api
  Jsii::Type.check_type(@api, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheS5JUmVzdEFwaSJ9")), "api")
  @stage_name = stage_name
  Jsii::Type.check_type(@stage_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stageName")
  @region = region
  Jsii::Type.check_type(@region, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "region") unless @region.nil?
end

Instance Attribute Details

#api ⇒ AWSCDK::APIGateway::IRestAPI (readonly)

API to call.

Returns:



232
233
234
 
# File 'step_functions_tasks/call_api_gateway_rest_api_endpoint_props.rb', line 232

def api
  @api
end

#api_path ⇒ String? (readonly)

Note:

Default: - No path

Path parameters appended after API endpoint.

Returns:

  • (String, nil) 


208
209
210
 
# File 'step_functions_tasks/call_api_gateway_rest_api_endpoint_props.rb', line 208

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



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

def assign
  @assign
end

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

Note:

Default: AuthType.NO_AUTH

Authentication methods.

Returns:



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

def auth_type
  @auth_type
end

#comment ⇒ String? (readonly)

Note:

Default: No comment

A comment describing this state.

Returns:

  • (String, nil) 


87
88
89
 
# File 'step_functions_tasks/call_api_gateway_rest_api_endpoint_props.rb', line 87

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:



108
109
110
 
# File 'step_functions_tasks/call_api_gateway_rest_api_endpoint_props.rb', line 108

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:



218
219
220
 
# File 'step_functions_tasks/call_api_gateway_rest_api_endpoint_props.rb', line 218

def headers
  @headers
end

#heartbeat ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use heartbeatTimeout

Note:

Default: - None

Timeout for the heartbeat.

Returns:



114
115
116
 
# File 'step_functions_tasks/call_api_gateway_rest_api_endpoint_props.rb', line 114

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:



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

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) 


162
163
164
 
# File 'step_functions_tasks/call_api_gateway_rest_api_endpoint_props.rb', line 162

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:



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

def integration_pattern
  @integration_pattern
end

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

Http method for the API.

Returns:



203
204
205
 
# File 'step_functions_tasks/call_api_gateway_rest_api_endpoint_props.rb', line 203

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) 


170
171
172
 
# File 'step_functions_tasks/call_api_gateway_rest_api_endpoint_props.rb', line 170

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:



182
183
184
 
# File 'step_functions_tasks/call_api_gateway_rest_api_endpoint_props.rb', line 182

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:



95
96
97
 
# File 'step_functions_tasks/call_api_gateway_rest_api_endpoint_props.rb', line 95

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:



223
224
225
 
# File 'step_functions_tasks/call_api_gateway_rest_api_endpoint_props.rb', line 223

def query_parameters
  @query_parameters
end

#region ⇒ String? (readonly)

Note:

Default: - Uses the Region of the stack containing the api.

Specify a custom Region where the API is deployed, e.g. 'us-east-1'.

Returns:

  • (String, nil) 


241
242
243
 
# File 'step_functions_tasks/call_api_gateway_rest_api_endpoint_props.rb', line 241

def region
  @region
end

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

Note:

Default: - No request body

HTTP Request body.

Returns:



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

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


190
191
192
 
# File 'step_functions_tasks/call_api_gateway_rest_api_endpoint_props.rb', line 190

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:



199
200
201
 
# File 'step_functions_tasks/call_api_gateway_rest_api_endpoint_props.rb', line 199

def result_selector
  @result_selector
end

#stage_name ⇒ String (readonly)

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

Returns:

  • (String) 


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

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) 


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

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:



140
141
142
 
# File 'step_functions_tasks/call_api_gateway_rest_api_endpoint_props.rb', line 140

def task_timeout
  @task_timeout
end

#timeout ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use taskTimeout

Note:

Default: - None

Timeout for the task.

Returns:



146
147
148
 
# File 'step_functions_tasks/call_api_gateway_rest_api_endpoint_props.rb', line 146

def timeout
  @timeout
end

Class Method Details

.jsii_properties ⇒ Object 



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'step_functions_tasks/call_api_gateway_rest_api_endpoint_props.rb', line 243

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",
    :method => "method",
    :api_path => "apiPath",
    :auth_type => "authType",
    :headers => "headers",
    :query_parameters => "queryParameters",
    :request_body => "requestBody",
    :api => "api",
    :stage_name => "stageName",
    :region => "region",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'step_functions_tasks/call_api_gateway_rest_api_endpoint_props.rb', line 272

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