Class DynamoGetItemProps.Builder
java.lang.Object
software.amazon.awscdk.services.stepfunctions.tasks.DynamoGetItemProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<DynamoGetItemProps>
- Enclosing interface:
DynamoGetItemProps
@Stability(Stable)
public static final class DynamoGetItemProps.Builder
extends Object
implements software.amazon.jsii.Builder<DynamoGetItemProps>
A builder for
DynamoGetItemProps
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.Sets the value ofTaskStateBaseProps.getComment()
consistentRead
(Boolean consistentRead) Sets the value ofDynamoGetItemProps.getConsistentRead()
expressionAttributeNames
(Map<String, String> expressionAttributeNames) Sets the value ofDynamoGetItemProps.getExpressionAttributeNames()
Sets the value ofTaskStateBaseProps.getHeartbeat()
Sets the value ofTaskStateBaseProps.getInputPath()
integrationPattern
(IntegrationPattern integrationPattern) Sets the value ofTaskStateBaseProps.getIntegrationPattern()
key
(Map<String, ? extends DynamoAttributeValue> key) Sets the value ofDynamoGetItemProps.getKey()
outputPath
(String outputPath) Sets the value ofTaskStateBaseProps.getOutputPath()
projectionExpression
(List<? extends DynamoProjectionExpression> projectionExpression) Sets the value ofDynamoGetItemProps.getProjectionExpression()
resultPath
(String resultPath) Sets the value ofTaskStateBaseProps.getResultPath()
resultSelector
(Map<String, ? extends Object> resultSelector) Sets the value ofTaskStateBaseProps.getResultSelector()
returnConsumedCapacity
(DynamoConsumedCapacity returnConsumedCapacity) Sets the value ofDynamoGetItemProps.getReturnConsumedCapacity()
Sets the value ofDynamoGetItemProps.getTable()
Sets the value ofTaskStateBaseProps.getTimeout()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
key
@Stability(Stable) public DynamoGetItemProps.Builder key(Map<String, ? extends DynamoAttributeValue> key) Sets the value ofDynamoGetItemProps.getKey()
- Parameters:
key
- Primary key of the item to retrieve. This parameter is required. 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.- Returns:
this
-
table
Sets the value ofDynamoGetItemProps.getTable()
- Parameters:
table
- The name of the table containing the requested item. This parameter is required.- Returns:
this
-
consistentRead
Sets the value ofDynamoGetItemProps.getConsistentRead()
- Parameters:
consistentRead
- Determines the read consistency model: If set to true, then the operation uses strongly consistent reads;. otherwise, the operation uses eventually consistent reads.- Returns:
this
-
expressionAttributeNames
@Stability(Stable) public DynamoGetItemProps.Builder expressionAttributeNames(Map<String, String> expressionAttributeNames) Sets the value ofDynamoGetItemProps.getExpressionAttributeNames()
- Parameters:
expressionAttributeNames
- One or more substitution tokens for attribute names in an expression.- Returns:
this
-
projectionExpression
@Stability(Stable) public DynamoGetItemProps.Builder projectionExpression(List<? extends DynamoProjectionExpression> projectionExpression) Sets the value ofDynamoGetItemProps.getProjectionExpression()
- Parameters:
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.- Returns:
this
-
returnConsumedCapacity
@Stability(Stable) public DynamoGetItemProps.Builder returnConsumedCapacity(DynamoConsumedCapacity returnConsumedCapacity) Sets the value ofDynamoGetItemProps.getReturnConsumedCapacity()
- Parameters:
returnConsumedCapacity
- Determines the level of detail about provisioned throughput consumption that is returned in the response.- Returns:
this
-
comment
Sets the value ofTaskStateBaseProps.getComment()
- Parameters:
comment
- An optional description for this state.- Returns:
this
-
heartbeat
Sets the value ofTaskStateBaseProps.getHeartbeat()
- Parameters:
heartbeat
- Timeout for the heartbeat.- Returns:
this
-
inputPath
Sets the value ofTaskStateBaseProps.getInputPath()
- Parameters:
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 {}.- Returns:
this
-
integrationPattern
@Stability(Stable) public DynamoGetItemProps.Builder integrationPattern(IntegrationPattern integrationPattern) Sets the value ofTaskStateBaseProps.getIntegrationPattern()
- Parameters:
integrationPattern
- AWS Step Functions integrates with services directly in the Amazon States Language. You can control these AWS services using service integration patterns- Returns:
this
-
outputPath
Sets the value ofTaskStateBaseProps.getOutputPath()
- Parameters:
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 {}.- Returns:
this
-
resultPath
Sets the value ofTaskStateBaseProps.getResultPath()
- Parameters:
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.- Returns:
this
-
resultSelector
@Stability(Stable) public DynamoGetItemProps.Builder resultSelector(Map<String, ? extends Object> resultSelector) Sets the value ofTaskStateBaseProps.getResultSelector()
- Parameters:
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.- Returns:
this
-
timeout
Sets the value ofTaskStateBaseProps.getTimeout()
- Parameters:
timeout
- Timeout for the state machine.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<DynamoGetItemProps>
- Returns:
- a new instance of
DynamoGetItemProps
- Throws:
NullPointerException
- if any required attribute was not provided
-