DynamoPutItem.Builder (software.amazon.awscdk:aws-cdk-lib 2.36.0 API)

java.lang.Object
- software.amazon.awscdk.services.stepfunctions.tasks.DynamoPutItem.Builder

All Implemented Interfaces:: software.amazon.jsii.Builder<DynamoPutItem>

Enclosing class:: DynamoPutItem

@Stability(value=Stable)
public static final class DynamoPutItem.Builder
extends Object
implements software.amazon.jsii.Builder<DynamoPutItem>

A fluent builder for DynamoPutItem.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DynamoPutItem`	`build()`
`DynamoPutItem.Builder`	`comment(String comment)` An optional description for this state.
`DynamoPutItem.Builder`	`conditionExpression(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, String id)`
`DynamoPutItem.Builder`	`expressionAttributeNames(Map<String,String> expressionAttributeNames)` One or more substitution tokens for attribute names in an expression.
`DynamoPutItem.Builder`	`expressionAttributeValues(Map<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(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(Map<String,? extends DynamoAttributeValue> item)` A map of attribute name/value pairs, one for each attribute.
`DynamoPutItem.Builder`	`outputPath(String outputPath)` JSONPath expression to select select a portion of the state output to pass to the next state.
`DynamoPutItem.Builder`	`resultPath(String resultPath)` JSONPath expression to indicate where to inject the state's output.
`DynamoPutItem.Builder`	`resultSelector(Map<String,? extends 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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - create
```
@Stability(value=Stable)
public static DynamoPutItem.Builder create(software.constructs.Construct scope,
                                                                    String id)
```
    Parameters:
    
    scope - This parameter is required.
    
    id - This parameter is required.
    
    Returns:
    
    a new instance of DynamoPutItem.Builder.
  - comment
```
@Stability(value=Stable)
public DynamoPutItem.Builder comment(String comment)
```
    An optional description for this state.
    Default: - No comment
    
    Parameters:
    
    comment - An optional description for this state. This parameter is required.
    
    Returns:
    
    this
  - heartbeat
```
@Stability(value=Stable)
public DynamoPutItem.Builder heartbeat(Duration heartbeat)
```
    Timeout for the heartbeat.
    Default: - None
    
    Parameters:
    
    heartbeat - Timeout for the heartbeat. This parameter is required.
    
    Returns:
    
    this
  - inputPath
```
@Stability(value=Stable)
public DynamoPutItem.Builder inputPath(String inputPath)
```
    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 '$')
    
    Parameters:
    
    inputPath - JSONPath expression to select part of the state to be the input to this state. This parameter is required.
    
    Returns:
    
    this
  - integrationPattern
```
@Stability(value=Stable)
public DynamoPutItem.Builder integrationPattern(IntegrationPattern 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_RESPONSE` for most tasks. `IntegrationPattern.RUN_JOB` for the following exceptions: `BatchSubmitJob`, `EmrAddStep`, `EmrCreateCluster`, `EmrTerminationCluster`, and `EmrContainersStartJobRun`.
    
    Parameters:
    
    integrationPattern - AWS Step Functions integrates with services directly in the Amazon States Language. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token
  - outputPath
```
@Stability(value=Stable)
public DynamoPutItem.Builder outputPath(String outputPath)
```
    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 '$')
    
    Parameters:
    
    outputPath - JSONPath expression to select select a portion of the state output to pass to the next state. This parameter is required.
    
    Returns:
    
    this
  - resultPath
```
@Stability(value=Stable)
public DynamoPutItem.Builder resultPath(String resultPath)
```
    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 '$')
    
    Parameters:
    
    resultPath - JSONPath expression to indicate where to inject the state's output. This parameter is required.
    
    Returns:
    
    this
  - resultSelector
```
@Stability(value=Stable)
public DynamoPutItem.Builder resultSelector(Map<String,? extends Object> resultSelector)
```
    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.
    Default: - None
    
    Parameters:
    
    resultSelector - The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector
  - timeout
```
@Stability(value=Stable)
public DynamoPutItem.Builder timeout(Duration timeout)
```
    Timeout for the state machine.
    Default: - None
    
    Parameters:
    
    timeout - Timeout for the state machine. This parameter is required.
    
    Returns:
    
    this
  - item
```
@Stability(value=Stable)
public DynamoPutItem.Builder item(Map<String,? extends DynamoAttributeValue> 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.
    
    Parameters:
    
    item - A map of attribute name/value pairs, one for each attribute. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_PutItem.html#DDB-PutItem-request-Item
  - table
```
@Stability(value=Stable)
public DynamoPutItem.Builder table(ITable table)
```
    The name of the table where the item should be written .
    
    Parameters:
    
    table - The name of the table where the item should be written . This parameter is required.
    
    Returns:
    
    this
  - conditionExpression
```
@Stability(value=Stable)
public DynamoPutItem.Builder conditionExpression(String conditionExpression)
```
    A condition that must be satisfied in order for a conditional PutItem operation to succeed.
    Default: - No condition expression
    
    Parameters:
    
    conditionExpression - A condition that must be satisfied in order for a conditional PutItem operation to succeed. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_PutItem.html#DDB-PutItem-request-ConditionExpression
  - expressionAttributeNames
```
@Stability(value=Stable)
public DynamoPutItem.Builder expressionAttributeNames(Map<String,String> expressionAttributeNames)
```
    One or more substitution tokens for attribute names in an expression.
    Default: - No expression attribute names
    
    Parameters:
    
    expressionAttributeNames - One or more substitution tokens for attribute names in an expression. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_PutItem.html#DDB-PutItem-request-ExpressionAttributeNames
  - expressionAttributeValues
```
@Stability(value=Stable)
public DynamoPutItem.Builder expressionAttributeValues(Map<String,? extends DynamoAttributeValue> expressionAttributeValues)
```
    One or more values that can be substituted in an expression.
    Default: - No expression attribute values
    
    Parameters:
    
    expressionAttributeValues - One or more values that can be substituted in an expression. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_PutItem.html#DDB-PutItem-request-ExpressionAttributeValues
  - returnConsumedCapacity
```
@Stability(value=Stable)
public DynamoPutItem.Builder returnConsumedCapacity(DynamoConsumedCapacity returnConsumedCapacity)
```
    Determines the level of detail about provisioned throughput consumption that is returned in the response.
    Default: DynamoConsumedCapacity.NONE
    
    Parameters:
    
    returnConsumedCapacity - Determines the level of detail about provisioned throughput consumption that is returned in the response. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_PutItem.html#DDB-PutItem-request-ReturnConsumedCapacity
  - returnItemCollectionMetrics
```
@Stability(value=Stable)
public DynamoPutItem.Builder returnItemCollectionMetrics(DynamoItemCollectionMetrics returnItemCollectionMetrics)
```
    The item collection metrics to returned in the response.
    Default: DynamoItemCollectionMetrics.NONE
    
    Parameters:
    
    returnItemCollectionMetrics - The item collection metrics to returned in the response. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LSI.html#LSI.ItemCollections
  - returnValues
```
@Stability(value=Stable)
public 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.
    Default: DynamoReturnValues.NONE
    
    Parameters:
    
    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.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_PutItem.html#DDB-PutItem-request-ReturnValues
  - build
```
@Stability(value=Stable)
public DynamoPutItem build()
```
    Specified by:
    
    build in interface software.amazon.jsii.Builder<DynamoPutItem>

Class DynamoPutItem.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

comment

heartbeat

inputPath

integrationPattern

outputPath

resultPath

resultSelector

timeout

item

table

conditionExpression

expressionAttributeNames

expressionAttributeValues

returnConsumedCapacity

returnItemCollectionMetrics

returnValues

build