DynamoPutItemProps¶
-
class
aws_cdk.aws_stepfunctions_tasks.
DynamoPutItemProps
(*, comment=None, heartbeat=None, input_path=None, integration_pattern=None, output_path=None, result_path=None, timeout=None, item, table, condition_expression=None, expression_attribute_names=None, expression_attribute_values=None, return_consumed_capacity=None, return_item_collection_metrics=None, return_values=None)¶ Bases:
aws_cdk.aws_stepfunctions.TaskStateBaseProps
Properties for DynamoPutItem Task.
- Parameters
comment (
Optional
[str
]) – An optional description for this state. Default: - No commentheartbeat (
Optional
[Duration
]) – Timeout for the heartbeat. Default: - Noneinput_path (
Optional
[str
]) – 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 {}. Default: - The entire task input (JSON path ‘$’)integration_pattern (
Optional
[IntegrationPattern
]) – AWS Step Functions integrates with services directly in the Amazon States Language. You can control these AWS services using service integration patterns Default: IntegrationPattern.REQUEST_RESPONSEoutput_path (
Optional
[str
]) – JSONPath expression to select select a portion of the state output to pass to the next state. May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}. Default: - The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path ‘$’)result_path (
Optional
[str
]) – 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. Default: - Replaces the entire input with the result (JSON path ‘$’)timeout (
Optional
[Duration
]) – Timeout for the state machine. Default: - Noneitem (
Mapping
[str
,DynamoAttributeValue
]) – 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.table (
ITable
) – The name of the table where the item should be written .condition_expression (
Optional
[str
]) – A condition that must be satisfied in order for a conditional PutItem operation to succeed. Default: - No condition expressionexpression_attribute_names (
Optional
[Mapping
[str
,str
]]) – One or more substitution tokens for attribute names in an expression. Default: - No expression attribute namesexpression_attribute_values (
Optional
[Mapping
[str
,DynamoAttributeValue
]]) – One or more values that can be substituted in an expression. Default: - No expression attribute valuesreturn_consumed_capacity (
Optional
[DynamoConsumedCapacity
]) – Determines the level of detail about provisioned throughput consumption that is returned in the response. Default: DynamoConsumedCapacity.NONEreturn_item_collection_metrics (
Optional
[DynamoItemCollectionMetrics
]) – The item collection metrics to returned in the response. Default: DynamoItemCollectionMetrics.NONEreturn_values (
Optional
[DynamoReturnValues
]) – Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request. Default: DynamoReturnValues.NONE
Attributes
-
comment
¶ An optional description for this state.
- Default
No comment
- Return type
Optional
[str
]
-
condition_expression
¶ A condition that must be satisfied in order for a conditional PutItem operation to succeed.
- Default
No condition expression
- See
- Return type
Optional
[str
]
-
expression_attribute_names
¶ One or more substitution tokens for attribute names in an expression.
- Default
No expression attribute names
- See
- Return type
Optional
[Mapping
[str
,str
]]
-
expression_attribute_values
¶ One or more values that can be substituted in an expression.
- Default
No expression attribute values
- See
- Return type
Optional
[Mapping
[str
,DynamoAttributeValue
]]
-
input_path
¶ 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 {}.
- Default
The entire task input (JSON path ‘$’)
- Return type
Optional
[str
]
-
integration_pattern
¶ AWS Step Functions integrates with services directly in the Amazon States Language.
You can control these AWS services using service integration patterns
- Default
IntegrationPattern.REQUEST_RESPONSE
- See
https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token
- Return type
Optional
[IntegrationPattern
]
-
item
¶ 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.
- See
- Return type
Mapping
[str
,DynamoAttributeValue
]
-
output_path
¶ JSONPath expression to select select a portion of the state output to pass to the next state.
May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
- Default
The entire JSON node determined by the state input, the task result,
and resultPath is passed to the next state (JSON path ‘$’)
- Return type
Optional
[str
]
-
result_path
¶ 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.
- Default
Replaces the entire input with the result (JSON path ‘$’)
- Return type
Optional
[str
]
-
return_consumed_capacity
¶ Determines the level of detail about provisioned throughput consumption that is returned in the response.
- Default
DynamoConsumedCapacity.NONE
- See
- Return type
Optional
[DynamoConsumedCapacity
]
-
return_item_collection_metrics
¶ The item collection metrics to returned in the response.
- Default
DynamoItemCollectionMetrics.NONE
- See
https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LSI.html#LSI.ItemCollections
- Return type
Optional
[DynamoItemCollectionMetrics
]
-
return_values
¶ Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request.
- Default
DynamoReturnValues.NONE
- See
- Return type
Optional
[DynamoReturnValues
]