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

Class DynamoGetItemJsonataProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<DynamoGetItemJsonataProps>

Enclosing interface:

DynamoGetItemJsonataProps

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

A builder for DynamoGetItemJsonataProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DynamoGetItemJsonataProps.Builder	assign(Map<String,? extends Object> assign)	Sets the value of AssignableStateOptions.getAssign()
DynamoGetItemJsonataProps	build()	Builds the configured instance.
DynamoGetItemJsonataProps.Builder	comment(String comment)	Sets the value of StateBaseProps.getComment()
DynamoGetItemJsonataProps.Builder	consistentRead(Boolean consistentRead)	Sets the value of DynamoGetItemJsonataProps.getConsistentRead()
DynamoGetItemJsonataProps.Builder	credentials(Credentials credentials)	Sets the value of TaskStateBaseOptions.getCredentials()
DynamoGetItemJsonataProps.Builder	expressionAttributeNames(Map<String,String> expressionAttributeNames)	Sets the value of DynamoGetItemJsonataProps.getExpressionAttributeNames()
DynamoGetItemJsonataProps.Builder	heartbeat(Duration heartbeat)	Deprecated. use `heartbeatTimeout`
DynamoGetItemJsonataProps.Builder	heartbeatTimeout(Timeout heartbeatTimeout)	Sets the value of TaskStateBaseOptions.getHeartbeatTimeout()
DynamoGetItemJsonataProps.Builder	integrationPattern(IntegrationPattern integrationPattern)	Sets the value of TaskStateBaseOptions.getIntegrationPattern()
DynamoGetItemJsonataProps.Builder	key(Map<String,? extends DynamoAttributeValue> key)	Sets the value of DynamoGetItemJsonataProps.getKey()
DynamoGetItemJsonataProps.Builder	outputs(Object outputs)	Sets the value of JsonataCommonOptions.getOutputs()
DynamoGetItemJsonataProps.Builder	projectionExpression(List<? extends DynamoProjectionExpression> projectionExpression)	Sets the value of DynamoGetItemJsonataProps.getProjectionExpression()
DynamoGetItemJsonataProps.Builder	queryLanguage(QueryLanguage queryLanguage)	Sets the value of StateBaseProps.getQueryLanguage()
DynamoGetItemJsonataProps.Builder	returnConsumedCapacity(DynamoConsumedCapacity returnConsumedCapacity)	Sets the value of DynamoGetItemJsonataProps.getReturnConsumedCapacity()
DynamoGetItemJsonataProps.Builder	stateName(String stateName)	Sets the value of StateBaseProps.getStateName()
DynamoGetItemJsonataProps.Builder	table(ITable table)	Sets the value of DynamoGetItemJsonataProps.getTable()
DynamoGetItemJsonataProps.Builder	taskTimeout(Timeout taskTimeout)	Sets the value of TaskStateBaseOptions.getTaskTimeout()
DynamoGetItemJsonataProps.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

key

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

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

Sets the value of DynamoGetItemJsonataProps.getTable()

Parameters:

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

Returns:

this

consistentRead

@Stability(Stable)
public DynamoGetItemJsonataProps.Builder consistentRead(Boolean consistentRead)

Sets the value of DynamoGetItemJsonataProps.getConsistentRead()

Parameters:

consistentRead - Determines the read consistency model: If set to true, then the operation uses strongly consistent reads;. otherwise, the operation uses eventually consistent reads.

Returns:

this

expressionAttributeNames

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

Sets the value of DynamoGetItemJsonataProps.getExpressionAttributeNames()

Parameters:

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

Returns:

this

projectionExpression

@Stability(Stable)
public DynamoGetItemJsonataProps.Builder projectionExpression(List<? extends DynamoProjectionExpression> projectionExpression)

Sets the value of DynamoGetItemJsonataProps.getProjectionExpression()

Parameters:

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.

Returns:

this

returnConsumedCapacity

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

Sets the value of DynamoGetItemJsonataProps.getReturnConsumedCapacity()

Parameters:

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

Returns:

this

comment

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

Sets the value of StateBaseProps.getComment()

Parameters:

comment - A comment describing this state.

Returns:

this

queryLanguage

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

Sets the value of StateBaseProps.getStateName()

Parameters:

stateName - Optional name for this state.

Returns:

this

credentials

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of DynamoGetItemJsonataProps

Throws:

NullPointerException - if any required attribute was not provided