Class: AWSCDK::StepFunctionsTasks::AthenaStartQueryExecutionJsonPathProps

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

Overview

Properties for starting a Query Execution 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, query_string:, client_request_token: nil, execution_parameters: nil, query_execution_context: nil, result_configuration: nil, result_reuse_configuration_max_age: nil, work_group: nil) ⇒ AthenaStartQueryExecutionJsonPathProps

Returns a new instance of AthenaStartQueryExecutionJsonPathProps.

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.

  • query_string (String) —

    Query that will be started.

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

    Unique string string to ensure idempotence.

  • execution_parameters (Array<String>, nil) (defaults to: nil) —

    A list of values for the parameters in a query.

  • query_execution_context (AWSCDK::StepFunctionsTasks::QueryExecutionContext, nil) (defaults to: nil) —

    Database within which query executes.

  • result_configuration (AWSCDK::StepFunctionsTasks::ResultConfiguration, nil) (defaults to: nil) —

    Configuration on how and where to save query.

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

    Specifies, in minutes, the maximum age of a previous query result that Athena should consider for reuse.

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

    Configuration on how and where to save query.



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/athena_start_query_execution_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, query_string:, client_request_token: nil, execution_parameters: nil, query_execution_context: nil, result_configuration: nil, result_reuse_configuration_max_age: nil, work_group: 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?
  @query_string = query_string
  Jsii::Type.check_type(@query_string, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "queryString")
  @client_request_token = client_request_token
  Jsii::Type.check_type(@client_request_token, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clientRequestToken") unless @client_request_token.nil?
  @execution_parameters = execution_parameters
  Jsii::Type.check_type(@execution_parameters, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "executionParameters") unless @execution_parameters.nil?
  @query_execution_context = query_execution_context.is_a?(Hash) ? ::AWSCDK::StepFunctionsTasks::QueryExecutionContext.new(**query_execution_context.transform_keys(&:to_sym)) : query_execution_context
  Jsii::Type.check_type(@query_execution_context, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9uc190YXNrcy5RdWVyeUV4ZWN1dGlvbkNvbnRleHQifQ==")), "queryExecutionContext") unless @query_execution_context.nil?
  @result_configuration = result_configuration.is_a?(Hash) ? ::AWSCDK::StepFunctionsTasks::ResultConfiguration.new(**result_configuration.transform_keys(&:to_sym)) : result_configuration
  Jsii::Type.check_type(@result_configuration, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9uc190YXNrcy5SZXN1bHRDb25maWd1cmF0aW9uIn0=")), "resultConfiguration") unless @result_configuration.nil?
  @result_reuse_configuration_max_age = result_reuse_configuration_max_age
  Jsii::Type.check_type(@result_reuse_configuration_max_age, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5EdXJhdGlvbiJ9")), "resultReuseConfigurationMaxAge") unless @result_reuse_configuration_max_age.nil?
  @work_group = work_group
  Jsii::Type.check_type(@work_group, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "workGroup") unless @work_group.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/athena_start_query_execution_json_path_props.rb', line 144

def assign
  @assign
end

#client_request_token ⇒ String? (readonly)

Note:

Default: - No client request token

Unique string string to ensure idempotence.

Returns:

  • (String, nil) 


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

def client_request_token
  @client_request_token
end

#comment ⇒ String? (readonly)

Note:

Default: No comment

A comment describing this state.

Returns:

  • (String, nil) 


77
78
79
 
# File 'step_functions_tasks/athena_start_query_execution_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/athena_start_query_execution_json_path_props.rb', line 98

def credentials
  @credentials
end

#execution_parameters ⇒ Array<String>? (readonly)

Note:

Default: - No parameters

A list of values for the parameters in a query.

The values are applied sequentially to the parameters in the query in the order in which the parameters occur.

Returns:

  • (Array<String>, nil) 


194
195
196
 
# File 'step_functions_tasks/athena_start_query_execution_json_path_props.rb', line 194

def execution_parameters
  @execution_parameters
end

#heartbeat ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use heartbeatTimeout

Note:

Default: - None

Timeout for the heartbeat.

Returns:



104
105
106
 
# File 'step_functions_tasks/athena_start_query_execution_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/athena_start_query_execution_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/athena_start_query_execution_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/athena_start_query_execution_json_path_props.rb', line 122

def integration_pattern
  @integration_pattern
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/athena_start_query_execution_json_path_props.rb', line 160

def output_path
  @output_path
end

#query_execution_context ⇒ AWSCDK::StepFunctionsTasks::QueryExecutionContext? (readonly)

Note:

Default: - No query execution context

Database within which query executes.

Returns:



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

def query_execution_context
  @query_execution_context
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/athena_start_query_execution_json_path_props.rb', line 85

def query_language
  @query_language
end

#query_string ⇒ String (readonly)

Query that will be started.

Returns:

  • (String) 


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

def query_string
  @query_string
end

#result_configuration ⇒ AWSCDK::StepFunctionsTasks::ResultConfiguration? (readonly)

Note:

Default: - No result configuration

Configuration on how and where to save query.

Returns:



204
205
206
 
# File 'step_functions_tasks/athena_start_query_execution_json_path_props.rb', line 204

def result_configuration
  @result_configuration
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/athena_start_query_execution_json_path_props.rb', line 168

def result_path
  @result_path
end

#result_reuse_configuration_max_age ⇒ AWSCDK::Duration? (readonly)

Note:

Default: - Query results are not reused

Specifies, in minutes, the maximum age of a previous query result that Athena should consider for reuse.

Returns:



209
210
211
 
# File 'step_functions_tasks/athena_start_query_execution_json_path_props.rb', line 209

def result_reuse_configuration_max_age
  @result_reuse_configuration_max_age
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/athena_start_query_execution_json_path_props.rb', line 177

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) 


90
91
92
 
# File 'step_functions_tasks/athena_start_query_execution_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/athena_start_query_execution_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/athena_start_query_execution_json_path_props.rb', line 136

def timeout
  @timeout
end

#work_group ⇒ String? (readonly)

Note:

Default: - No work group

Configuration on how and where to save query.

Returns:

  • (String, nil) 


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

def work_group
  @work_group
end

Class Method Details

.jsii_properties ⇒ Object 



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'step_functions_tasks/athena_start_query_execution_json_path_props.rb', line 216

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",
    :query_string => "queryString",
    :client_request_token => "clientRequestToken",
    :execution_parameters => "executionParameters",
    :query_execution_context => "queryExecutionContext",
    :result_configuration => "resultConfiguration",
    :result_reuse_configuration_max_age => "resultReuseConfigurationMaxAge",
    :work_group => "workGroup",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



242
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
 
# File 'step_functions_tasks/athena_start_query_execution_json_path_props.rb', line 242

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,
    "queryString" => @query_string,
    "clientRequestToken" => @client_request_token,
    "executionParameters" => @execution_parameters,
    "queryExecutionContext" => @query_execution_context,
    "resultConfiguration" => @result_configuration,
    "resultReuseConfigurationMaxAge" => @result_reuse_configuration_max_age,
    "workGroup" => @work_group,
  })
  result.compact
end