Class: AWSCDK::StepFunctionsTasks::DynamoUpdateItemJsonPathProps

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

Overview

Properties for DynamoUpdateItem Task 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, key:, table:, condition_expression: nil, expression_attribute_names: nil, expression_attribute_values: nil, return_consumed_capacity: nil, return_item_collection_metrics: nil, return_values: nil, update_expression: nil) ⇒ DynamoUpdateItemJsonPathProps

Returns a new instance of DynamoUpdateItemJsonPathProps.

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.

  • key (Hash{String => AWSCDK::StepFunctionsTasks::DynamoAttributeValue}) —

    Primary key of the item to retrieve.

  • table (AWSCDK::Interfaces::AWSDynamodb::ITableRef) —

    The name of the table containing the requested item.

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

    A condition that must be satisfied in order for a conditional DeleteItem to succeed.

  • expression_attribute_names (Hash{String => String}, nil) (defaults to: nil) —

    One or more substitution tokens for attribute names in an expression.

  • expression_attribute_values (Hash{String => AWSCDK::StepFunctionsTasks::DynamoAttributeValue}, nil) (defaults to: nil) —

    One or more values that can be substituted in an expression.

  • return_consumed_capacity (AWSCDK::StepFunctionsTasks::DynamoConsumedCapacity, nil) (defaults to: nil) —

    Determines the level of detail about provisioned throughput consumption that is returned in the response.

  • return_item_collection_metrics (AWSCDK::StepFunctionsTasks::DynamoItemCollectionMetrics, nil) (defaults to: nil) —

    Determines whether item collection metrics are returned.

  • return_values (AWSCDK::StepFunctionsTasks::DynamoReturnValues, nil) (defaults to: nil) —

    Use ReturnValues if you want to get the item attributes as they appeared before they were deleted.

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

    An expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them.



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
75
76
77
 
# File 'step_functions_tasks/dynamo_update_item_json_path_props.rb', line 30

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, key:, table:, condition_expression: nil, expression_attribute_names: nil, expression_attribute_values: nil, return_consumed_capacity: nil, return_item_collection_metrics: nil, return_values: nil, update_expression: 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?
  @key = key
  Jsii::Type.check_type(@key, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zdGVwZnVuY3Rpb25zX3Rhc2tzLkR5bmFtb0F0dHJpYnV0ZVZhbHVlIn0sImtpbmQiOiJtYXAifX0=")), "key")
  @table = table
  Jsii::Type.check_type(@table, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19keW5hbW9kYi5JVGFibGVSZWYifQ==")), "table")
  @condition_expression = condition_expression
  Jsii::Type.check_type(@condition_expression, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "conditionExpression") unless @condition_expression.nil?
  @expression_attribute_names = expression_attribute_names
  Jsii::Type.check_type(@expression_attribute_names, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "expressionAttributeNames") unless @expression_attribute_names.nil?
  @expression_attribute_values = expression_attribute_values
  Jsii::Type.check_type(@expression_attribute_values, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zdGVwZnVuY3Rpb25zX3Rhc2tzLkR5bmFtb0F0dHJpYnV0ZVZhbHVlIn0sImtpbmQiOiJtYXAifX0=")), "expressionAttributeValues") unless @expression_attribute_values.nil?
  @return_consumed_capacity = return_consumed_capacity
  Jsii::Type.check_type(@return_consumed_capacity, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9uc190YXNrcy5EeW5hbW9Db25zdW1lZENhcGFjaXR5In0=")), "returnConsumedCapacity") unless @return_consumed_capacity.nil?
  @return_item_collection_metrics = return_item_collection_metrics
  Jsii::Type.check_type(@return_item_collection_metrics, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9uc190YXNrcy5EeW5hbW9JdGVtQ29sbGVjdGlvbk1ldHJpY3MifQ==")), "returnItemCollectionMetrics") unless @return_item_collection_metrics.nil?
  @return_values = return_values
  Jsii::Type.check_type(@return_values, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9uc190YXNrcy5EeW5hbW9SZXR1cm5WYWx1ZXMifQ==")), "returnValues") unless @return_values.nil?
  @update_expression = update_expression
  Jsii::Type.check_type(@update_expression, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "updateExpression") unless @update_expression.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:



150
151
152
 
# File 'step_functions_tasks/dynamo_update_item_json_path_props.rb', line 150

def assign
  @assign
end

#comment ⇒ String? (readonly)

Note:

Default: No comment

A comment describing this state.

Returns:

  • (String, nil) 


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

def comment
  @comment
end

#condition_expression ⇒ String? (readonly)

Note:

Default: - No condition expression

A condition that must be satisfied in order for a conditional DeleteItem to succeed.

Returns:

  • (String, nil)

See Also:



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

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



104
105
106
 
# File 'step_functions_tasks/dynamo_update_item_json_path_props.rb', line 104

def credentials
  @credentials
end

#expression_attribute_names ⇒ Hash{String => String}? (readonly)

Note:

Default: - No expression attribute names

One or more substitution tokens for attribute names in an expression.

Returns:

  • (Hash{String => String}, nil)

See Also:



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

def expression_attribute_names
  @expression_attribute_names
end

#expression_attribute_values ⇒ Hash{String => AWSCDK::StepFunctionsTasks::DynamoAttributeValue}? (readonly)

Note:

Default: - No expression attribute values

One or more values that can be substituted in an expression.

Returns:

See Also:



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

def expression_attribute_values
  @expression_attribute_values
end

#heartbeat ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use heartbeatTimeout

Note:

Default: - None

Timeout for the heartbeat.

Returns:



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

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:



118
119
120
 
# File 'step_functions_tasks/dynamo_update_item_json_path_props.rb', line 118

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) 


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

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:



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

def integration_pattern
  @integration_pattern
end

#key ⇒ Hash{String => AWSCDK::StepFunctionsTasks::DynamoAttributeValue} (readonly)

Primary key of the item to retrieve.

For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

Returns:

See Also:



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

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


166
167
168
 
# File 'step_functions_tasks/dynamo_update_item_json_path_props.rb', line 166

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:



91
92
93
 
# File 'step_functions_tasks/dynamo_update_item_json_path_props.rb', line 91

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


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

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:



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

def result_selector
  @result_selector
end

#return_consumed_capacity ⇒ AWSCDK::StepFunctionsTasks::DynamoConsumedCapacity? (readonly)

Note:

Default: DynamoConsumedCapacity.NONE

Determines the level of detail about provisioned throughput consumption that is returned in the response.

Returns:

See Also:



220
221
222
 
# File 'step_functions_tasks/dynamo_update_item_json_path_props.rb', line 220

def return_consumed_capacity
  @return_consumed_capacity
end

#return_item_collection_metrics ⇒ AWSCDK::StepFunctionsTasks::DynamoItemCollectionMetrics? (readonly)

Note:

Default: DynamoItemCollectionMetrics.NONE

Determines whether item collection metrics are returned.

If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

Returns:



229
230
231
 
# File 'step_functions_tasks/dynamo_update_item_json_path_props.rb', line 229

def return_item_collection_metrics
  @return_item_collection_metrics
end

#return_values ⇒ AWSCDK::StepFunctionsTasks::DynamoReturnValues? (readonly)

Note:

Default: DynamoReturnValues.NONE

Use ReturnValues if you want to get the item attributes as they appeared before they were deleted.

Returns:

See Also:



235
236
237
 
# File 'step_functions_tasks/dynamo_update_item_json_path_props.rb', line 235

def return_values
  @return_values
end

#state_name ⇒ String? (readonly)

Note:

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

Optional name for this state.

Returns:

  • (String, nil) 


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

def state_name
  @state_name
end

#table ⇒ AWSCDK::Interfaces::AWSDynamodb::ITableRef (readonly)

The name of the table containing the requested item.

Returns:



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

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



136
137
138
 
# File 'step_functions_tasks/dynamo_update_item_json_path_props.rb', line 136

def task_timeout
  @task_timeout
end

#timeout ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use taskTimeout

Note:

Default: - None

Timeout for the task.

Returns:



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

def timeout
  @timeout
end

#update_expression ⇒ String? (readonly)

Note:

Default: - No update expression

An expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them.

Returns:

  • (String, nil)

See Also:



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

def update_expression
  @update_expression
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
 
# File 'step_functions_tasks/dynamo_update_item_json_path_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",
    :result_path => "resultPath",
    :result_selector => "resultSelector",
    :key => "key",
    :table => "table",
    :condition_expression => "conditionExpression",
    :expression_attribute_names => "expressionAttributeNames",
    :expression_attribute_values => "expressionAttributeValues",
    :return_consumed_capacity => "returnConsumedCapacity",
    :return_item_collection_metrics => "returnItemCollectionMetrics",
    :return_values => "returnValues",
    :update_expression => "updateExpression",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



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

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,
    "key" => @key,
    "table" => @table,
    "conditionExpression" => @condition_expression,
    "expressionAttributeNames" => @expression_attribute_names,
    "expressionAttributeValues" => @expression_attribute_values,
    "returnConsumedCapacity" => @return_consumed_capacity,
    "returnItemCollectionMetrics" => @return_item_collection_metrics,
    "returnValues" => @return_values,
    "updateExpression" => @update_expression,
  })
  result.compact
end