public static final class DynamoUpdateItem.Builder
extends java.lang.Object
DynamoUpdateItem
.Modifier and Type | Method and Description |
---|---|
DynamoUpdateItem |
build() |
DynamoUpdateItem.Builder |
comment(java.lang.String comment)
An optional description for this state.
|
DynamoUpdateItem.Builder |
conditionExpression(java.lang.String conditionExpression)
A condition that must be satisfied in order for a conditional DeleteItem to succeed.
|
static DynamoUpdateItem.Builder |
create(software.constructs.Construct scope,
java.lang.String id) |
DynamoUpdateItem.Builder |
expressionAttributeNames(java.util.Map<java.lang.String,java.lang.String> expressionAttributeNames)
One or more substitution tokens for attribute names in an expression.
|
DynamoUpdateItem.Builder |
expressionAttributeValues(java.util.Map<java.lang.String,? extends DynamoAttributeValue> expressionAttributeValues)
One or more values that can be substituted in an expression.
|
DynamoUpdateItem.Builder |
heartbeat(Duration heartbeat)
Timeout for the heartbeat.
|
DynamoUpdateItem.Builder |
inputPath(java.lang.String inputPath)
JSONPath expression to select part of the state to be the input to this state.
|
DynamoUpdateItem.Builder |
integrationPattern(IntegrationPattern integrationPattern)
AWS Step Functions integrates with services directly in the Amazon States Language.
|
DynamoUpdateItem.Builder |
key(java.util.Map<java.lang.String,? extends DynamoAttributeValue> key)
Primary key of the item to retrieve.
|
DynamoUpdateItem.Builder |
outputPath(java.lang.String outputPath)
JSONPath expression to select select a portion of the state output to pass to the next state.
|
DynamoUpdateItem.Builder |
resultPath(java.lang.String resultPath)
JSONPath expression to indicate where to inject the state's output.
|
DynamoUpdateItem.Builder |
resultSelector(java.util.Map<java.lang.String,? extends java.lang.Object> resultSelector)
The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
|
DynamoUpdateItem.Builder |
returnConsumedCapacity(DynamoConsumedCapacity returnConsumedCapacity)
Determines the level of detail about provisioned throughput consumption that is returned in the response.
|
DynamoUpdateItem.Builder |
returnItemCollectionMetrics(DynamoItemCollectionMetrics returnItemCollectionMetrics)
Determines whether item collection metrics are returned.
|
DynamoUpdateItem.Builder |
returnValues(DynamoReturnValues returnValues)
Use ReturnValues if you want to get the item attributes as they appeared before they were deleted.
|
DynamoUpdateItem.Builder |
table(ITable table)
The name of the table containing the requested item.
|
DynamoUpdateItem.Builder |
timeout(Duration timeout)
Timeout for the state machine.
|
DynamoUpdateItem.Builder |
updateExpression(java.lang.String updateExpression)
An expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them.
|
public static DynamoUpdateItem.Builder create(software.constructs.Construct scope, java.lang.String id)
scope
- This parameter is required.id
- This parameter is required.DynamoUpdateItem.Builder
.public DynamoUpdateItem.Builder comment(java.lang.String comment)
Default: - No comment
comment
- An optional description for this state. This parameter is required.this
public DynamoUpdateItem.Builder heartbeat(Duration heartbeat)
Default: - None
heartbeat
- Timeout for the heartbeat. This parameter is required.this
public DynamoUpdateItem.Builder inputPath(java.lang.String inputPath)
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 '$')
inputPath
- JSONPath expression to select part of the state to be the input to this state. This parameter is required.this
public DynamoUpdateItem.Builder integrationPattern(IntegrationPattern integrationPattern)
You can control these AWS services using service integration patterns
Default: - `IntegrationPattern.REQUEST_RESPONSE` for most tasks. `IntegrationPattern.RUN_JOB` for the following exceptions: `BatchSubmitJob`, `EmrAddStep`, `EmrCreateCluster`, `EmrTerminationCluster`, and `EmrContainersStartJobRun`.
integrationPattern
- AWS Step Functions integrates with services directly in the Amazon States Language. This parameter is required.this
public DynamoUpdateItem.Builder outputPath(java.lang.String outputPath)
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 '$')
outputPath
- JSONPath expression to select select a portion of the state output to pass to the next state. This parameter is required.this
public DynamoUpdateItem.Builder resultPath(java.lang.String resultPath)
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 '$')
resultPath
- JSONPath expression to indicate where to inject the state's output. This parameter is required.this
public DynamoUpdateItem.Builder resultSelector(java.util.Map<java.lang.String,? extends java.lang.Object> resultSelector)
You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.
Default: - None
resultSelector
- The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. This parameter is required.this
public DynamoUpdateItem.Builder timeout(Duration timeout)
Default: - None
timeout
- Timeout for the state machine. This parameter is required.this
public DynamoUpdateItem.Builder key(java.util.Map<java.lang.String,? extends DynamoAttributeValue> key)
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.
key
- Primary key of the item to retrieve. This parameter is required.this
public DynamoUpdateItem.Builder table(ITable table)
table
- The name of the table containing the requested item. This parameter is required.this
public DynamoUpdateItem.Builder conditionExpression(java.lang.String conditionExpression)
Default: - No condition expression
conditionExpression
- A condition that must be satisfied in order for a conditional DeleteItem to succeed. This parameter is required.this
public DynamoUpdateItem.Builder expressionAttributeNames(java.util.Map<java.lang.String,java.lang.String> expressionAttributeNames)
Default: - No expression attribute names
expressionAttributeNames
- One or more substitution tokens for attribute names in an expression. This parameter is required.this
public DynamoUpdateItem.Builder expressionAttributeValues(java.util.Map<java.lang.String,? extends DynamoAttributeValue> expressionAttributeValues)
Default: - No expression attribute values
expressionAttributeValues
- One or more values that can be substituted in an expression. This parameter is required.this
public DynamoUpdateItem.Builder returnConsumedCapacity(DynamoConsumedCapacity returnConsumedCapacity)
Default: DynamoConsumedCapacity.NONE
returnConsumedCapacity
- Determines the level of detail about provisioned throughput consumption that is returned in the response. This parameter is required.this
public DynamoUpdateItem.Builder returnItemCollectionMetrics(DynamoItemCollectionMetrics returnItemCollectionMetrics)
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.
Default: DynamoItemCollectionMetrics.NONE
returnItemCollectionMetrics
- Determines whether item collection metrics are returned. This parameter is required.this
public DynamoUpdateItem.Builder returnValues(DynamoReturnValues returnValues)
Default: DynamoReturnValues.NONE
returnValues
- Use ReturnValues if you want to get the item attributes as they appeared before they were deleted. This parameter is required.this
public DynamoUpdateItem.Builder updateExpression(java.lang.String updateExpression)
Default: - No update expression
updateExpression
- An expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them. This parameter is required.this
public DynamoUpdateItem build()