Package software.amazon.awscdk.services.stepfunctions.tasks

Class DynamoUpdateItemProps.Builder

java.lang.Object

software.amazon.awscdk.services.stepfunctions.tasks.DynamoUpdateItemProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DynamoUpdateItemProps>

Enclosing interface:

DynamoUpdateItemProps

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

A builder for DynamoUpdateItemProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DynamoUpdateItemProps.Builder	assign(Map<String,? extends Object> assign)	Sets the value of AssignableStateOptions.getAssign()
DynamoUpdateItemProps	build()	Builds the configured instance.
DynamoUpdateItemProps.Builder	comment(String comment)	Sets the value of StateBaseProps.getComment()
DynamoUpdateItemProps.Builder	conditionExpression(String conditionExpression)	Sets the value of DynamoUpdateItemProps.getConditionExpression()
DynamoUpdateItemProps.Builder	credentials(Credentials credentials)	Sets the value of TaskStateBaseOptions.getCredentials()
DynamoUpdateItemProps.Builder	expressionAttributeNames(Map<String,String> expressionAttributeNames)	Sets the value of DynamoUpdateItemProps.getExpressionAttributeNames()
DynamoUpdateItemProps.Builder	expressionAttributeValues(Map<String,? extends DynamoAttributeValue> expressionAttributeValues)	Sets the value of DynamoUpdateItemProps.getExpressionAttributeValues()
DynamoUpdateItemProps.Builder	heartbeat(Duration heartbeat)	Deprecated. use `heartbeatTimeout`
DynamoUpdateItemProps.Builder	heartbeatTimeout(Timeout heartbeatTimeout)	Sets the value of TaskStateBaseOptions.getHeartbeatTimeout()
DynamoUpdateItemProps.Builder	inputPath(String inputPath)	Sets the value of JsonPathCommonOptions.getInputPath()
DynamoUpdateItemProps.Builder	integrationPattern(IntegrationPattern integrationPattern)	Sets the value of TaskStateBaseOptions.getIntegrationPattern()
DynamoUpdateItemProps.Builder	key(Map<String,? extends DynamoAttributeValue> key)	Sets the value of DynamoUpdateItemProps.getKey()
DynamoUpdateItemProps.Builder	outputPath(String outputPath)	Sets the value of JsonPathCommonOptions.getOutputPath()
DynamoUpdateItemProps.Builder	outputs(Object outputs)	Sets the value of JsonataCommonOptions.getOutputs()
DynamoUpdateItemProps.Builder	queryLanguage(QueryLanguage queryLanguage)	Sets the value of StateBaseProps.getQueryLanguage()
DynamoUpdateItemProps.Builder	resultPath(String resultPath)	Sets the value of TaskStateBaseProps.getResultPath()
DynamoUpdateItemProps.Builder	resultSelector(Map<String,? extends Object> resultSelector)	Sets the value of TaskStateBaseProps.getResultSelector()
DynamoUpdateItemProps.Builder	returnConsumedCapacity(DynamoConsumedCapacity returnConsumedCapacity)	Sets the value of DynamoUpdateItemProps.getReturnConsumedCapacity()
DynamoUpdateItemProps.Builder	returnItemCollectionMetrics(DynamoItemCollectionMetrics returnItemCollectionMetrics)	Sets the value of DynamoUpdateItemProps.getReturnItemCollectionMetrics()
DynamoUpdateItemProps.Builder	returnValues(DynamoReturnValues returnValues)	Sets the value of DynamoUpdateItemProps.getReturnValues()
DynamoUpdateItemProps.Builder	stateName(String stateName)	Sets the value of StateBaseProps.getStateName()
DynamoUpdateItemProps.Builder	table(ITable table)	Sets the value of DynamoUpdateItemProps.getTable()
DynamoUpdateItemProps.Builder	taskTimeout(Timeout taskTimeout)	Sets the value of TaskStateBaseOptions.getTaskTimeout()
DynamoUpdateItemProps.Builder	timeout(Duration timeout)	Deprecated. use `taskTimeout`
DynamoUpdateItemProps.Builder	updateExpression(String updateExpression)	Sets the value of DynamoUpdateItemProps.getUpdateExpression()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

key

@Stability(Stable)
public DynamoUpdateItemProps.Builder key(Map<String,? extends DynamoAttributeValue> key)

Sets the value of DynamoUpdateItemProps.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

@Stability(Stable)
public DynamoUpdateItemProps.Builder table(ITable table)

Sets the value of DynamoUpdateItemProps.getTable()

Parameters:

table - The name of the table containing the requested item. This parameter is required.

Returns:

this

conditionExpression

@Stability(Stable)
public DynamoUpdateItemProps.Builder conditionExpression(String conditionExpression)

Sets the value of DynamoUpdateItemProps.getConditionExpression()

Parameters:

conditionExpression - A condition that must be satisfied in order for a conditional DeleteItem to succeed.

Returns:

this

expressionAttributeNames

@Stability(Stable)
public DynamoUpdateItemProps.Builder expressionAttributeNames(Map<String,String> expressionAttributeNames)

Sets the value of DynamoUpdateItemProps.getExpressionAttributeNames()

Parameters:

expressionAttributeNames - One or more substitution tokens for attribute names in an expression.

Returns:

this

expressionAttributeValues

@Stability(Stable)
public DynamoUpdateItemProps.Builder expressionAttributeValues(Map<String,? extends DynamoAttributeValue> expressionAttributeValues)

Sets the value of DynamoUpdateItemProps.getExpressionAttributeValues()

Parameters:

expressionAttributeValues - One or more values that can be substituted in an expression.

Returns:

this

returnConsumedCapacity

@Stability(Stable)
public DynamoUpdateItemProps.Builder returnConsumedCapacity(DynamoConsumedCapacity returnConsumedCapacity)

Sets the value of DynamoUpdateItemProps.getReturnConsumedCapacity()

Parameters:

returnConsumedCapacity - Determines the level of detail about provisioned throughput consumption that is returned in the response.

Returns:

this

returnItemCollectionMetrics

@Stability(Stable)
public DynamoUpdateItemProps.Builder returnItemCollectionMetrics(DynamoItemCollectionMetrics returnItemCollectionMetrics)

Sets the value of DynamoUpdateItemProps.getReturnItemCollectionMetrics()

Parameters:

returnItemCollectionMetrics - Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

Returns:

this

returnValues

@Stability(Stable)
public DynamoUpdateItemProps.Builder returnValues(DynamoReturnValues returnValues)

Sets the value of DynamoUpdateItemProps.getReturnValues()

Parameters:

returnValues - Use ReturnValues if you want to get the item attributes as they appeared before they were deleted.

Returns:

this

updateExpression

@Stability(Stable)
public DynamoUpdateItemProps.Builder updateExpression(String updateExpression)

Sets the value of DynamoUpdateItemProps.getUpdateExpression()

Parameters:

updateExpression - An expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them.

Returns:

this

resultPath

@Stability(Stable)
public DynamoUpdateItemProps.Builder resultPath(String resultPath)

Sets the value of TaskStateBaseProps.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 DynamoUpdateItemProps.Builder resultSelector(Map<String,? extends Object> resultSelector)

Sets the value of TaskStateBaseProps.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

comment

@Stability(Stable)
public DynamoUpdateItemProps.Builder comment(String comment)

Sets the value of StateBaseProps.getComment()

Parameters:

comment - A comment describing this state.

Returns:

this

queryLanguage

@Stability(Stable)
public DynamoUpdateItemProps.Builder queryLanguage(QueryLanguage queryLanguage)

Sets the value of StateBaseProps.getQueryLanguage()

Parameters:

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-level queryLanguage field.

Returns:

this

stateName

@Stability(Stable)
public DynamoUpdateItemProps.Builder stateName(String stateName)

Sets the value of StateBaseProps.getStateName()

Parameters:

stateName - Optional name for this state.

Returns:

this

credentials

@Stability(Stable)
public DynamoUpdateItemProps.Builder credentials(Credentials credentials)

Sets the value of TaskStateBaseOptions.getCredentials()

Parameters:

credentials - Credentials for an IAM Role that the State Machine assumes for executing the task. This enables cross-account resource invocations.

Returns:

this

heartbeat

@Stability(Deprecated)
@Deprecated
public DynamoUpdateItemProps.Builder heartbeat(Duration heartbeat)

Deprecated.

use `heartbeatTimeout`

Sets the value of TaskStateBaseOptions.getHeartbeat()

Parameters:

heartbeat - Timeout for the heartbeat.

Returns:

this

heartbeatTimeout

@Stability(Stable)
public DynamoUpdateItemProps.Builder heartbeatTimeout(Timeout heartbeatTimeout)

Sets the value of TaskStateBaseOptions.getHeartbeatTimeout()

Parameters:

heartbeatTimeout - Timeout for the heartbeat. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Returns:

this

integrationPattern

@Stability(Stable)
public DynamoUpdateItemProps.Builder integrationPattern(IntegrationPattern integrationPattern)

Sets the value of TaskStateBaseOptions.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.

Depending on the AWS Service, the Service Integration Pattern availability will vary.

Returns:

this

taskTimeout

@Stability(Stable)
public DynamoUpdateItemProps.Builder taskTimeout(Timeout taskTimeout)

Sets the value of TaskStateBaseOptions.getTaskTimeout()

Parameters:

taskTimeout - Timeout for the task. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Returns:

this

timeout

@Stability(Deprecated)
@Deprecated
public DynamoUpdateItemProps.Builder timeout(Duration timeout)

Deprecated.

use `taskTimeout`

Sets the value of TaskStateBaseOptions.getTimeout()

Parameters:

timeout - Timeout for the task.

Returns:

this

assign

@Stability(Stable)
public DynamoUpdateItemProps.Builder assign(Map<String,? extends Object> assign)

Sets the value of AssignableStateOptions.getAssign()

Parameters:

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.

Returns:

this

inputPath

@Stability(Stable)
public DynamoUpdateItemProps.Builder inputPath(String inputPath)

Sets the value of JsonPathCommonOptions.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

outputPath

@Stability(Stable)
public DynamoUpdateItemProps.Builder outputPath(String outputPath)

Sets the value of JsonPathCommonOptions.getOutputPath()

Parameters:

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 {}.

Returns:

this

outputs

@Stability(Stable)
public DynamoUpdateItemProps.Builder outputs(Object outputs)

Sets the value of JsonataCommonOptions.getOutputs()

Parameters:

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.

Returns:

this

build

@Stability(Stable)
public DynamoUpdateItemProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<DynamoUpdateItemProps>

Returns:

a new instance of DynamoUpdateItemProps

Throws:

NullPointerException - if any required attribute was not provided