Class DynamoGetItem.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<DynamoGetItem>
- Enclosing class:
DynamoGetItem
DynamoGetItem
.-
Method Summary
Modifier and TypeMethodDescriptionWorkflow variables to store in this step.build()
A comment describing this state.consistentRead
(Boolean consistentRead) Determines the read consistency model: If set to true, then the operation uses strongly consistent reads;static DynamoGetItem.Builder
credentials
(Credentials credentials) Credentials for an IAM Role that the State Machine assumes for executing the task.expressionAttributeNames
(Map<String, String> expressionAttributeNames) One or more substitution tokens for attribute names in an expression.Deprecated.heartbeatTimeout
(Timeout heartbeatTimeout) Timeout for the heartbeat.JSONPath expression to select part of the state to be the input to this state.integrationPattern
(IntegrationPattern integrationPattern) AWS Step Functions integrates with services directly in the Amazon States Language.key
(Map<String, ? extends DynamoAttributeValue> key) Primary key of the item to retrieve.outputPath
(String outputPath) JSONPath expression to select part of the state to be the output to this state.Used to specify and transform output from the state.projectionExpression
(List<? extends DynamoProjectionExpression> projectionExpression) An array of DynamoProjectionExpression that identifies one or more attributes to retrieve from the table.queryLanguage
(QueryLanguage queryLanguage) The name of the query language used by the state.resultPath
(String resultPath) JSONPath expression to indicate where to inject the state's output.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.returnConsumedCapacity
(DynamoConsumedCapacity returnConsumedCapacity) Determines the level of detail about provisioned throughput consumption that is returned in the response.Optional name for this state.The name of the table containing the requested item.taskTimeout
(Timeout taskTimeout) Timeout for the task.Deprecated.usetaskTimeout
-
Method Details
-
create
@Stability(Stable) public static DynamoGetItem.Builder create(software.constructs.Construct scope, String id) - Parameters:
scope
- This parameter is required.id
- Descriptive identifier for this chainable. This parameter is required.- Returns:
- a new instance of
DynamoGetItem.Builder
.
-
comment
A comment describing this state.Default: No comment
- Parameters:
comment
- A comment describing this state. This parameter is required.- Returns:
this
-
queryLanguage
The name of the query language used by the state.If the state does not contain a
queryLanguage
field, then it will use the query language specified in the top-levelqueryLanguage
field.Default: - JSONPath
- Parameters:
queryLanguage
- The name of the query language used by the state. This parameter is required.- Returns:
this
-
stateName
Optional name for this state.Default: - The construct ID will be used as state name
- Parameters:
stateName
- Optional name for this state. This parameter is required.- Returns:
this
-
credentials
Credentials for an IAM Role that the State Machine assumes for executing the task.This enables cross-account resource invocations.
Default: - None (Task is executed using the State Machine's execution role)
- Parameters:
credentials
- Credentials for an IAM Role that the State Machine assumes for executing the task. This parameter is required.- Returns:
this
- See Also:
-
heartbeat
Deprecated.useheartbeatTimeout
(deprecated) Timeout for the heartbeat.Default: - None
- Parameters:
heartbeat
- Timeout for the heartbeat. This parameter is required.- Returns:
this
-
heartbeatTimeout
Timeout for the heartbeat.[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
Default: - None
- Parameters:
heartbeatTimeout
- Timeout for the heartbeat. This parameter is required.- Returns:
this
-
integrationPattern
@Stability(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.
Depending on the AWS Service, the Service Integration Pattern availability will vary.
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:
-
taskTimeout
Timeout for the task.[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
Default: - None
- Parameters:
taskTimeout
- Timeout for the task. This parameter is required.- Returns:
this
-
timeout
Deprecated.usetaskTimeout
(deprecated) Timeout for the task.Default: - None
- Parameters:
timeout
- Timeout for the task. This parameter is required.- Returns:
this
-
assign
Workflow variables to store in this step.Using workflow variables, you can store data in a step and retrieve that data in future steps.
Default: - Not assign variables
- Parameters:
assign
- Workflow variables to store in this step. This parameter is required.- Returns:
this
- See Also:
-
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: $
- Parameters:
inputPath
- JSONPath expression to select part of the state to be the input to this state. This parameter is required.- Returns:
this
-
outputPath
JSONPath expression to select part of the state to be the output to this state.May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
Default: $
- Parameters:
outputPath
- JSONPath expression to select part of the state to be the output to this state. This parameter is required.- Returns:
this
-
outputs
Used to specify and transform output from the state.When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.
Default: - $states.result or $states.errorOutput
- Parameters:
outputs
- Used to specify and transform output from the state. This parameter is required.- Returns:
this
- See Also:
-
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: $
- Parameters:
resultPath
- JSONPath expression to indicate where to inject the state's output. This parameter is required.- Returns:
this
-
resultSelector
@Stability(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:
-
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:
-
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
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(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:
-
projectionExpression
@Stability(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:
-
returnConsumedCapacity
@Stability(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:
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<DynamoGetItem>
- Returns:
- a newly built instance of
DynamoGetItem
.
-
heartbeatTimeout