DynamoGetItem.Builder (software.amazon.awscdk:stepfunctions-tasks 1.187.0 API)

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

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

Enclosing class:: DynamoGetItem

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

A fluent builder for DynamoGetItem.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DynamoGetItem`	`build()`
`DynamoGetItem.Builder`	`comment(String comment)` An optional description for this state.
`DynamoGetItem.Builder`	`consistentRead(Boolean consistentRead)` Determines the read consistency model: If set to true, then the operation uses strongly consistent reads;
`static DynamoGetItem.Builder`	`create(software.constructs.Construct scope, String id)`
`DynamoGetItem.Builder`	`expressionAttributeNames(Map<String,String> expressionAttributeNames)` One or more substitution tokens for attribute names in an expression.
`DynamoGetItem.Builder`	`heartbeat(Duration heartbeat)` Timeout for the heartbeat.
`DynamoGetItem.Builder`	`inputPath(String inputPath)` JSONPath expression to select part of the state to be the input to this state.
`DynamoGetItem.Builder`	`integrationPattern(IntegrationPattern integrationPattern)` AWS Step Functions integrates with services directly in the Amazon States Language.
`DynamoGetItem.Builder`	`key(Map<String,? extends DynamoAttributeValue> key)` Primary key of the item to retrieve.
`DynamoGetItem.Builder`	`outputPath(String outputPath)` JSONPath expression to select select a portion of the state output to pass to the next state.
`DynamoGetItem.Builder`	`projectionExpression(List<? extends DynamoProjectionExpression> projectionExpression)` An array of DynamoProjectionExpression that identifies one or more attributes to retrieve from the table.
`DynamoGetItem.Builder`	`resultPath(String resultPath)` JSONPath expression to indicate where to inject the state's output.
`DynamoGetItem.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.
`DynamoGetItem.Builder`	`returnConsumedCapacity(DynamoConsumedCapacity returnConsumedCapacity)` Determines the level of detail about provisioned throughput consumption that is returned in the response.
`DynamoGetItem.Builder`	`table(ITable table)` The name of the table containing the requested item.
`DynamoGetItem.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 DynamoGetItem.Builder create(software.constructs.Construct scope,
                                                                    String id)
```
    Parameters:
    
    scope - This parameter is required.
    
    id - This parameter is required.
    
    Returns:
    
    a new instance of DynamoGetItem.Builder.
  - comment
```
@Stability(value=Stable)
public DynamoGetItem.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 DynamoGetItem.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 DynamoGetItem.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 DynamoGetItem.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 DynamoGetItem.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 DynamoGetItem.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 DynamoGetItem.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 DynamoGetItem.Builder timeout(Duration timeout)
```
    Timeout for the state machine.
    Default: - None
    
    Parameters:
    
    timeout - Timeout for the state machine. This parameter is required.
    
    Returns:
    
    this
  - key
```
@Stability(value=Stable)
public DynamoGetItem.Builder key(Map<String,? extends DynamoAttributeValue> key)
```
    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.
    
    Parameters:
    
    key - Primary key of the item to retrieve. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_GetItem.html#DDB-GetItem-request-Key
  - table
```
@Stability(value=Stable)
public DynamoGetItem.Builder table(ITable table)
```
    The name of the table containing the requested item.
    
    Parameters:
    
    table - The name of the table containing the requested item. This parameter is required.
    
    Returns:
    
    this
  - consistentRead
```
@Stability(value=Stable)
public DynamoGetItem.Builder consistentRead(Boolean consistentRead)
```
    Determines the read consistency model: If set to true, then the operation uses strongly consistent reads;
    otherwise, the operation uses eventually consistent reads.
    Default: false
    
    Parameters:
    
    consistentRead - Determines the read consistency model: If set to true, then the operation uses strongly consistent reads;. This parameter is required.
    
    Returns:
    
    this
  - expressionAttributeNames
```
@Stability(value=Stable)
public DynamoGetItem.Builder expressionAttributeNames(Map<String,String> expressionAttributeNames)
```
    One or more substitution tokens for attribute names in an expression.
    Default: - No expression attributes
    
    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_GetItem.html#DDB-GetItem-request-ExpressionAttributeNames
  - projectionExpression
```
@Stability(value=Stable)
public DynamoGetItem.Builder projectionExpression(List<? extends DynamoProjectionExpression> projectionExpression)
```
    An array of DynamoProjectionExpression that identifies one or more attributes to retrieve from the table.
    These attributes can include scalars, sets, or elements of a JSON document.
    Default: - No projection expression
    
    Parameters:
    
    projectionExpression - An array of DynamoProjectionExpression that identifies one or more attributes to retrieve from the table. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_GetItem.html#DDB-GetItem-request-ProjectionExpression
  - returnConsumedCapacity
```
@Stability(value=Stable)
public DynamoGetItem.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_GetItem.html#DDB-GetItem-request-ReturnConsumedCapacity
  - build
```
@Stability(value=Stable)
public DynamoGetItem build()
```
    Specified by:
    
    build in interface software.amazon.jsii.Builder<DynamoGetItem>

Class DynamoGetItem.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

comment

heartbeat

inputPath

integrationPattern

outputPath

resultPath

resultSelector

timeout

key

table

consistentRead

expressionAttributeNames

projectionExpression

returnConsumedCapacity

build