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

Class DynamoPutItemJsonataProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<DynamoPutItemJsonataProps>

Enclosing interface:

DynamoPutItemJsonataProps

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

A builder for DynamoPutItemJsonataProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

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

item

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

Sets the value of DynamoPutItemJsonataProps.getItem()

Parameters:

item - A map of attribute name/value pairs, one for each attribute. This parameter is required. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.

Returns:

this

table

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

Sets the value of DynamoPutItemJsonataProps.getTable()

Parameters:

table - The name of the table where the item should be written . This parameter is required.

Returns:

this

conditionExpression

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

Sets the value of DynamoPutItemJsonataProps.getConditionExpression()

Parameters:

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

Returns:

this

expressionAttributeNames

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

Sets the value of DynamoPutItemJsonataProps.getExpressionAttributeNames()

Parameters:

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

Returns:

this

expressionAttributeValues

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

Sets the value of DynamoPutItemJsonataProps.getExpressionAttributeValues()

Parameters:

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

Returns:

this

returnConsumedCapacity

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

Sets the value of DynamoPutItemJsonataProps.getReturnConsumedCapacity()

Parameters:

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

Returns:

this

returnItemCollectionMetrics

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

Sets the value of DynamoPutItemJsonataProps.getReturnItemCollectionMetrics()

Parameters:

returnItemCollectionMetrics - The item collection metrics to returned in the response.

Returns:

this

returnValues

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

Sets the value of DynamoPutItemJsonataProps.getReturnValues()

Parameters:

returnValues - Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request.

Returns:

this

comment

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

Sets the value of StateBaseProps.getComment()

Parameters:

comment - A comment describing this state.

Returns:

this

queryLanguage

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

Sets the value of StateBaseProps.getStateName()

Parameters:

stateName - Optional name for this state.

Returns:

this

credentials

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of DynamoPutItemJsonataProps

Throws:

NullPointerException - if any required attribute was not provided