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

Class DynamoUpdateItemJsonataProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<DynamoUpdateItemJsonataProps>

Enclosing interface:

DynamoUpdateItemJsonataProps

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

A builder for DynamoUpdateItemJsonataProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Sets the value of DynamoUpdateItemJsonataProps.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 DynamoUpdateItemJsonataProps.Builder table(ITable table)

Sets the value of DynamoUpdateItemJsonataProps.getTable()

Parameters:

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

Returns:

this

conditionExpression

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

Sets the value of DynamoUpdateItemJsonataProps.getConditionExpression()

Parameters:

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

Returns:

this

expressionAttributeNames

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

Sets the value of DynamoUpdateItemJsonataProps.getExpressionAttributeNames()

Parameters:

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

Returns:

this

expressionAttributeValues

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

Sets the value of DynamoUpdateItemJsonataProps.getExpressionAttributeValues()

Parameters:

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

Returns:

this

returnConsumedCapacity

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

Sets the value of DynamoUpdateItemJsonataProps.getReturnConsumedCapacity()

Parameters:

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

Returns:

this

returnItemCollectionMetrics

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

Sets the value of DynamoUpdateItemJsonataProps.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 DynamoUpdateItemJsonataProps.Builder returnValues(DynamoReturnValues returnValues)

Sets the value of DynamoUpdateItemJsonataProps.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 DynamoUpdateItemJsonataProps.Builder updateExpression(String updateExpression)

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

comment

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

Sets the value of StateBaseProps.getComment()

Parameters:

comment - A comment describing this state.

Returns:

this

queryLanguage

@Stability(Stable)
public DynamoUpdateItemJsonataProps.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 DynamoUpdateItemJsonataProps.Builder stateName(String stateName)

Sets the value of StateBaseProps.getStateName()

Parameters:

stateName - Optional name for this state.

Returns:

this

credentials

@Stability(Stable)
public DynamoUpdateItemJsonataProps.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 DynamoUpdateItemJsonataProps.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 DynamoUpdateItemJsonataProps.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 DynamoUpdateItemJsonataProps.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 DynamoUpdateItemJsonataProps.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 DynamoUpdateItemJsonataProps.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 DynamoUpdateItemJsonataProps.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

outputs

@Stability(Stable)
public DynamoUpdateItemJsonataProps.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 DynamoUpdateItemJsonataProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of DynamoUpdateItemJsonataProps

Throws:

NullPointerException - if any required attribute was not provided