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

Class DynamoPutItemProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<DynamoPutItemProps>

Enclosing interface:

DynamoPutItemProps

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

A builder for DynamoPutItemProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DynamoPutItemProps	build()	Builds the configured instance.
DynamoPutItemProps.Builder	comment(String comment)	Sets the value of TaskStateBaseProps.getComment()
DynamoPutItemProps.Builder	conditionExpression(String conditionExpression)	Sets the value of DynamoPutItemProps.getConditionExpression()
DynamoPutItemProps.Builder	credentials(Credentials credentials)	Sets the value of TaskStateBaseProps.getCredentials()
DynamoPutItemProps.Builder	expressionAttributeNames(Map<String,String> expressionAttributeNames)	Sets the value of DynamoPutItemProps.getExpressionAttributeNames()
DynamoPutItemProps.Builder	expressionAttributeValues(Map<String,? extends DynamoAttributeValue> expressionAttributeValues)	Sets the value of DynamoPutItemProps.getExpressionAttributeValues()
DynamoPutItemProps.Builder	heartbeat(Duration heartbeat)	Deprecated. use `heartbeatTimeout`
DynamoPutItemProps.Builder	heartbeatTimeout(Timeout heartbeatTimeout)	Sets the value of TaskStateBaseProps.getHeartbeatTimeout()
DynamoPutItemProps.Builder	inputPath(String inputPath)	Sets the value of TaskStateBaseProps.getInputPath()
DynamoPutItemProps.Builder	integrationPattern(IntegrationPattern integrationPattern)	Sets the value of TaskStateBaseProps.getIntegrationPattern()
DynamoPutItemProps.Builder	item(Map<String,? extends DynamoAttributeValue> item)	Sets the value of DynamoPutItemProps.getItem()
DynamoPutItemProps.Builder	outputPath(String outputPath)	Sets the value of TaskStateBaseProps.getOutputPath()
DynamoPutItemProps.Builder	resultPath(String resultPath)	Sets the value of TaskStateBaseProps.getResultPath()
DynamoPutItemProps.Builder	resultSelector(Map<String,? extends Object> resultSelector)	Sets the value of TaskStateBaseProps.getResultSelector()
DynamoPutItemProps.Builder	returnConsumedCapacity(DynamoConsumedCapacity returnConsumedCapacity)	Sets the value of DynamoPutItemProps.getReturnConsumedCapacity()
DynamoPutItemProps.Builder	returnItemCollectionMetrics(DynamoItemCollectionMetrics returnItemCollectionMetrics)	Sets the value of DynamoPutItemProps.getReturnItemCollectionMetrics()
DynamoPutItemProps.Builder	returnValues(DynamoReturnValues returnValues)	Sets the value of DynamoPutItemProps.getReturnValues()
DynamoPutItemProps.Builder	stateName(String stateName)	Sets the value of TaskStateBaseProps.getStateName()
DynamoPutItemProps.Builder	table(ITable table)	Sets the value of DynamoPutItemProps.getTable()
DynamoPutItemProps.Builder	taskTimeout(Timeout taskTimeout)	Sets the value of TaskStateBaseProps.getTaskTimeout()
DynamoPutItemProps.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 DynamoPutItemProps.Builder item(Map<String,? extends DynamoAttributeValue> item)

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

Sets the value of DynamoPutItemProps.getTable()

Parameters:

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

Returns:

this

conditionExpression

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

Sets the value of DynamoPutItemProps.getConditionExpression()

Parameters:

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

Returns:

this

expressionAttributeNames

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

Sets the value of DynamoPutItemProps.getExpressionAttributeNames()

Parameters:

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

Returns:

this

expressionAttributeValues

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

Sets the value of DynamoPutItemProps.getExpressionAttributeValues()

Parameters:

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

Returns:

this

returnConsumedCapacity

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

Sets the value of DynamoPutItemProps.getReturnConsumedCapacity()

Parameters:

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

Returns:

this

returnItemCollectionMetrics

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

Sets the value of DynamoPutItemProps.getReturnItemCollectionMetrics()

Parameters:

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

Returns:

this

returnValues

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

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

Sets the value of TaskStateBaseProps.getComment()

Parameters:

comment - An optional description for this state.

Returns:

this

credentials

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

Sets the value of TaskStateBaseProps.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 DynamoPutItemProps.Builder heartbeat(Duration heartbeat)

Deprecated.

use `heartbeatTimeout`

Sets the value of TaskStateBaseProps.getHeartbeat()

Parameters:

heartbeat - Timeout for the heartbeat.

Returns:

this

heartbeatTimeout

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

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

inputPath

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

Sets the value of TaskStateBaseProps.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 DynamoPutItemProps.Builder integrationPattern(IntegrationPattern integrationPattern)

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

outputPath

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

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

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

stateName

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

Sets the value of TaskStateBaseProps.getStateName()

Parameters:

stateName - Optional name for this state.

Returns:

this

taskTimeout

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

Sets the value of TaskStateBaseProps.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 DynamoPutItemProps.Builder timeout(Duration timeout)

Deprecated.

use `taskTimeout`

Sets the value of TaskStateBaseProps.getTimeout()

Parameters:

timeout - Timeout for the task.

Returns:

this

build

@Stability(Stable)
public DynamoPutItemProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of DynamoPutItemProps

Throws:

NullPointerException - if any required attribute was not provided