Class: AWSCDK::StepFunctionsTasks::AthenaStartQueryExecutionJsonataProps

Inherits:
AWSCDK::StepFunctions::TaskStateJsonataBaseProps
  • Object
show all
Defined in:
step_functions_tasks/athena_start_query_execution_jsonata_props.rb

Overview

Properties for starting a Query Execution 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, 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) ⇒ AthenaStartQueryExecutionJsonataProps

Returns a new instance of AthenaStartQueryExecutionJsonataProps.

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.

  • 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.



25
26
27
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
 
# File 'step_functions_tasks/athena_start_query_execution_jsonata_props.rb', line 25

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, 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?
  @outputs = outputs
  Jsii::Type.check_type(@outputs, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "outputs") unless @outputs.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:



135
136
137
 
# File 'step_functions_tasks/athena_start_query_execution_jsonata_props.rb', line 135

def assign
  @assign
end

#client_request_token ⇒ String? (readonly)

Note:

Default: - No client request token

Unique string string to ensure idempotence.

Returns:

  • (String, nil) 


156
157
158
 
# File 'step_functions_tasks/athena_start_query_execution_jsonata_props.rb', line 156

def client_request_token
  @client_request_token
end

#comment ⇒ String? (readonly)

Note:

Default: No comment

A comment describing this state.

Returns:

  • (String, nil) 


68
69
70
 
# File 'step_functions_tasks/athena_start_query_execution_jsonata_props.rb', line 68

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:



89
90
91
 
# File 'step_functions_tasks/athena_start_query_execution_jsonata_props.rb', line 89

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) 


164
165
166
 
# File 'step_functions_tasks/athena_start_query_execution_jsonata_props.rb', line 164

def execution_parameters
  @execution_parameters
end

#heartbeat ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use heartbeatTimeout

Note:

Default: - None

Timeout for the heartbeat.

Returns:



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

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:



103
104
105
 
# File 'step_functions_tasks/athena_start_query_execution_jsonata_props.rb', line 103

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:



113
114
115
 
# File 'step_functions_tasks/athena_start_query_execution_jsonata_props.rb', line 113

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



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

def outputs
  @outputs
end

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

Note:

Default: - No query execution context

Database within which query executes.

Returns:



169
170
171
 
# File 'step_functions_tasks/athena_start_query_execution_jsonata_props.rb', line 169

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:



76
77
78
 
# File 'step_functions_tasks/athena_start_query_execution_jsonata_props.rb', line 76

def query_language
  @query_language
end

#query_string ⇒ String (readonly)

Query that will be started.

Returns:

  • (String) 


151
152
153
 
# File 'step_functions_tasks/athena_start_query_execution_jsonata_props.rb', line 151

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:



174
175
176
 
# File 'step_functions_tasks/athena_start_query_execution_jsonata_props.rb', line 174

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



179
180
181
 
# File 'step_functions_tasks/athena_start_query_execution_jsonata_props.rb', line 179

def result_reuse_configuration_max_age
  @result_reuse_configuration_max_age
end

#state_name ⇒ String? (readonly)

Note:

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

Optional name for this state.

Returns:

  • (String, nil) 


81
82
83
 
# File 'step_functions_tasks/athena_start_query_execution_jsonata_props.rb', line 81

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:



121
122
123
 
# File 'step_functions_tasks/athena_start_query_execution_jsonata_props.rb', line 121

def task_timeout
  @task_timeout
end

#timeout ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use taskTimeout

Note:

Default: - None

Timeout for the task.

Returns:



127
128
129
 
# File 'step_functions_tasks/athena_start_query_execution_jsonata_props.rb', line 127

def timeout
  @timeout
end

#work_group ⇒ String? (readonly)

Note:

Default: - No work group

Configuration on how and where to save query.

Returns:

  • (String, nil) 


184
185
186
 
# File 'step_functions_tasks/athena_start_query_execution_jsonata_props.rb', line 184

def work_group
  @work_group
end

Class Method Details

.jsii_properties ⇒ Object 



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'step_functions_tasks/athena_start_query_execution_jsonata_props.rb', line 186

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",
    :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 



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'step_functions_tasks/athena_start_query_execution_jsonata_props.rb', line 209

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,
    "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