-
Notifications
You must be signed in to change notification settings - Fork 17
/
awsstepfunctionstasks_DynamoDeleteItemProps.go
111 lines (108 loc) · 5.63 KB
/
awsstepfunctionstasks_DynamoDeleteItemProps.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
package awsstepfunctionstasks
import (
"github.com/aws/aws-cdk-go/awscdk"
"github.com/aws/aws-cdk-go/awscdk/awsdynamodb"
"github.com/aws/aws-cdk-go/awscdk/awsstepfunctions"
)
// Properties for DynamoDeleteItem Task.
//
// Example:
// var myTable table
//
// tasks.NewDynamoDeleteItem(this, jsii.String("DeleteItem"), &dynamoDeleteItemProps{
// key: map[string]dynamoAttributeValue{
// "MessageId": tasks.*dynamoAttributeValue.fromString(jsii.String("message-007")),
// },
// table: myTable,
// resultPath: sfn.jsonPath_DISCARD(),
// })
//
// Experimental.
type DynamoDeleteItemProps struct {
// An optional description for this state.
// Experimental.
Comment *string `field:"optional" json:"comment" yaml:"comment"`
// Timeout for the heartbeat.
// Experimental.
Heartbeat awscdk.Duration `field:"optional" json:"heartbeat" yaml:"heartbeat"`
// 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 {}.
// Experimental.
InputPath *string `field:"optional" json:"inputPath" yaml:"inputPath"`
// AWS Step Functions integrates with services directly in the Amazon States Language.
//
// You can control these AWS services using service integration patterns.
// See: https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token
//
// Experimental.
IntegrationPattern awsstepfunctions.IntegrationPattern `field:"optional" json:"integrationPattern" yaml:"integrationPattern"`
// 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 {}.
// Experimental.
OutputPath *string `field:"optional" json:"outputPath" yaml:"outputPath"`
// 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.
// Experimental.
ResultPath *string `field:"optional" json:"resultPath" yaml:"resultPath"`
// 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.
// See: https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector
//
// Experimental.
ResultSelector *map[string]interface{} `field:"optional" json:"resultSelector" yaml:"resultSelector"`
// Timeout for the state machine.
// Experimental.
Timeout awscdk.Duration `field:"optional" json:"timeout" yaml:"timeout"`
// 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.
// See: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_GetItem.html#DDB-GetItem-request-Key
//
// Experimental.
Key *map[string]DynamoAttributeValue `field:"required" json:"key" yaml:"key"`
// The name of the table containing the requested item.
// Experimental.
Table awsdynamodb.ITable `field:"required" json:"table" yaml:"table"`
// A condition that must be satisfied in order for a conditional DeleteItem to succeed.
// See: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DeleteItem.html#DDB-DeleteItem-request-ConditionExpression
//
// Experimental.
ConditionExpression *string `field:"optional" json:"conditionExpression" yaml:"conditionExpression"`
// One or more substitution tokens for attribute names in an expression.
// See: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DeleteItem.html#DDB-DeleteItem-request-ExpressionAttributeNames
//
// Experimental.
ExpressionAttributeNames *map[string]*string `field:"optional" json:"expressionAttributeNames" yaml:"expressionAttributeNames"`
// One or more values that can be substituted in an expression.
// See: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DeleteItem.html#DDB-DeleteItem-request-ExpressionAttributeValues
//
// Experimental.
ExpressionAttributeValues *map[string]DynamoAttributeValue `field:"optional" json:"expressionAttributeValues" yaml:"expressionAttributeValues"`
// Determines the level of detail about provisioned throughput consumption that is returned in the response.
// See: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DeleteItem.html#DDB-DeleteItem-request-ReturnConsumedCapacity
//
// Experimental.
ReturnConsumedCapacity DynamoConsumedCapacity `field:"optional" json:"returnConsumedCapacity" yaml:"returnConsumedCapacity"`
// 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.
// Experimental.
ReturnItemCollectionMetrics DynamoItemCollectionMetrics `field:"optional" json:"returnItemCollectionMetrics" yaml:"returnItemCollectionMetrics"`
// Use ReturnValues if you want to get the item attributes as they appeared before they were deleted.
// See: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DeleteItem.html#DDB-DeleteItem-request-ReturnValues
//
// Experimental.
ReturnValues DynamoReturnValues `field:"optional" json:"returnValues" yaml:"returnValues"`
}