public static final class DynamoPutItem.Builder
extends java.lang.Object
DynamoPutItem
.Modifier and Type | Method and Description |
---|---|
DynamoPutItem |
build() |
DynamoPutItem.Builder |
comment(java.lang.String comment)
An optional description for this state.
|
DynamoPutItem.Builder |
conditionExpression(java.lang.String conditionExpression)
A condition that must be satisfied in order for a conditional PutItem operation to succeed.
|
static DynamoPutItem.Builder |
create(software.constructs.Construct scope,
java.lang.String id) |
DynamoPutItem.Builder |
expressionAttributeNames(java.util.Map<java.lang.String,java.lang.String> expressionAttributeNames)
One or more substitution tokens for attribute names in an expression.
|
DynamoPutItem.Builder |
expressionAttributeValues(java.util.Map<java.lang.String,? extends DynamoAttributeValue> expressionAttributeValues)
One or more values that can be substituted in an expression.
|
DynamoPutItem.Builder |
heartbeat(Duration heartbeat)
Timeout for the heartbeat.
|
DynamoPutItem.Builder |
inputPath(java.lang.String inputPath)
JSONPath expression to select part of the state to be the input to this state.
|
DynamoPutItem.Builder |
integrationPattern(IntegrationPattern integrationPattern)
AWS Step Functions integrates with services directly in the Amazon States Language.
|
DynamoPutItem.Builder |
item(java.util.Map<java.lang.String,? extends DynamoAttributeValue> item)
A map of attribute name/value pairs, one for each attribute.
|
DynamoPutItem.Builder |
outputPath(java.lang.String outputPath)
JSONPath expression to select select a portion of the state output to pass to the next state.
|
DynamoPutItem.Builder |
resultPath(java.lang.String resultPath)
JSONPath expression to indicate where to inject the state's output.
|
DynamoPutItem.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.
|
DynamoPutItem.Builder |
returnConsumedCapacity(DynamoConsumedCapacity returnConsumedCapacity)
Determines the level of detail about provisioned throughput consumption that is returned in the response.
|
DynamoPutItem.Builder |
returnItemCollectionMetrics(DynamoItemCollectionMetrics returnItemCollectionMetrics)
The item collection metrics to returned in the response.
|
DynamoPutItem.Builder |
returnValues(DynamoReturnValues returnValues)
Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request.
|
DynamoPutItem.Builder |
table(ITable table)
The name of the table where the item should be written .
|
DynamoPutItem.Builder |
timeout(Duration timeout)
Timeout for the state machine.
|
public static DynamoPutItem.Builder create(software.constructs.Construct scope, java.lang.String id)
scope
- This parameter is required.id
- This parameter is required.DynamoPutItem.Builder
.public DynamoPutItem.Builder comment(java.lang.String comment)
Default: - No comment
comment
- An optional description for this state. This parameter is required.this
public DynamoPutItem.Builder heartbeat(Duration heartbeat)
Default: - None
heartbeat
- Timeout for the heartbeat. This parameter is required.this
public DynamoPutItem.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 DynamoPutItem.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 DynamoPutItem.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 DynamoPutItem.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 DynamoPutItem.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 DynamoPutItem.Builder timeout(Duration timeout)
Default: - None
timeout
- Timeout for the state machine. This parameter is required.this
public DynamoPutItem.Builder item(java.util.Map<java.lang.String,? extends DynamoAttributeValue> item)
Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.
item
- A map of attribute name/value pairs, one for each attribute. This parameter is required.this
public DynamoPutItem.Builder table(ITable table)
table
- The name of the table where the item should be written . This parameter is required.this
public DynamoPutItem.Builder conditionExpression(java.lang.String conditionExpression)
Default: - No condition expression
conditionExpression
- A condition that must be satisfied in order for a conditional PutItem operation to succeed. This parameter is required.this
public DynamoPutItem.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 DynamoPutItem.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 DynamoPutItem.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 DynamoPutItem.Builder returnItemCollectionMetrics(DynamoItemCollectionMetrics returnItemCollectionMetrics)
Default: DynamoItemCollectionMetrics.NONE
returnItemCollectionMetrics
- The item collection metrics to returned in the response. This parameter is required.this
public DynamoPutItem.Builder returnValues(DynamoReturnValues returnValues)
Default: DynamoReturnValues.NONE
returnValues
- Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request. This parameter is required.this
public DynamoPutItem build()