Class: AWSCDK::StepFunctionsTasks::DynamoPutItemJsonataProps

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

Overview

Properties for DynamoPutItem Task 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, item:, table:, condition_expression: nil, expression_attribute_names: nil, expression_attribute_values: nil, return_consumed_capacity: nil, return_item_collection_metrics: nil, return_values: nil) ⇒ DynamoPutItemJsonataProps

Returns a new instance of DynamoPutItemJsonataProps.

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.

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

    A map of attribute name/value pairs, one for each attribute.

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

    The name of the table where the item should be written .

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

    A condition that must be satisfied in order for a conditional PutItem operation 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) —

    The item collection metrics to returned in the response.

  • 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 updated with the PutItem request.



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
63
64
65
 
# File 'step_functions_tasks/dynamo_put_item_jsonata_props.rb', line 26

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, item:, table:, condition_expression: nil, expression_attribute_names: nil, expression_attribute_values: nil, return_consumed_capacity: nil, return_item_collection_metrics: nil, return_values: 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?
  @item = item
  Jsii::Type.check_type(@item, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zdGVwZnVuY3Rpb25zX3Rhc2tzLkR5bmFtb0F0dHJpYnV0ZVZhbHVlIn0sImtpbmQiOiJtYXAifX0=")), "item")
  @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?
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:



138
139
140
 
# File 'step_functions_tasks/dynamo_put_item_jsonata_props.rb', line 138

def assign
  @assign
end

#comment ⇒ String? (readonly)

Note:

Default: No comment

A comment describing this state.

Returns:

  • (String, nil) 


71
72
73
 
# File 'step_functions_tasks/dynamo_put_item_jsonata_props.rb', line 71

def comment
  @comment
end

#condition_expression ⇒ String? (readonly)

Note:

Default: - No condition expression

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

Returns:

  • (String, nil)

See Also:



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

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:



92
93
94
 
# File 'step_functions_tasks/dynamo_put_item_jsonata_props.rb', line 92

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:



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

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:



180
181
182
 
# File 'step_functions_tasks/dynamo_put_item_jsonata_props.rb', line 180

def expression_attribute_values
  @expression_attribute_values
end

#heartbeat ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use heartbeatTimeout

Note:

Default: - None

Timeout for the heartbeat.

Returns:



98
99
100
 
# File 'step_functions_tasks/dynamo_put_item_jsonata_props.rb', line 98

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:



106
107
108
 
# File 'step_functions_tasks/dynamo_put_item_jsonata_props.rb', line 106

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:



116
117
118
 
# File 'step_functions_tasks/dynamo_put_item_jsonata_props.rb', line 116

def integration_pattern
  @integration_pattern
end

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

A map of attribute name/value pairs, one for each attribute.

Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.

Returns:

See Also:



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

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



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

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:



79
80
81
 
# File 'step_functions_tasks/dynamo_put_item_jsonata_props.rb', line 79

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



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

def return_consumed_capacity
  @return_consumed_capacity
end

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

Note:

Default: DynamoItemCollectionMetrics.NONE

The item collection metrics to returned in the response.

Returns:

See Also:



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

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 updated with the PutItem request.

Returns:

See Also:



198
199
200
 
# File 'step_functions_tasks/dynamo_put_item_jsonata_props.rb', line 198

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) 


84
85
86
 
# File 'step_functions_tasks/dynamo_put_item_jsonata_props.rb', line 84

def state_name
  @state_name
end

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

The name of the table where the item should be written .

Returns:



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

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:



124
125
126
 
# File 'step_functions_tasks/dynamo_put_item_jsonata_props.rb', line 124

def task_timeout
  @task_timeout
end

#timeout ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use taskTimeout

Note:

Default: - None

Timeout for the task.

Returns:



130
131
132
 
# File 'step_functions_tasks/dynamo_put_item_jsonata_props.rb', line 130

def timeout
  @timeout
end

Class Method Details

.jsii_properties ⇒ Object 



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'step_functions_tasks/dynamo_put_item_jsonata_props.rb', line 200

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",
    :item => "item",
    :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",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



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/dynamo_put_item_jsonata_props.rb', line 224

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,
    "item" => @item,
    "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,
  })
  result.compact
end