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

Class DynamoPutItem.Builder

java.lang.Object
software.amazon.awscdk.services.stepfunctions.tasks.DynamoPutItem.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<DynamoPutItem>
Enclosing class:
DynamoPutItem
@Stability(Stable) public static final class DynamoPutItem.Builder extends Object implements software.amazon.jsii.Builder<DynamoPutItem>
A fluent builder for DynamoPutItem.

  • Method Details

    • create

      @Stability(Stable) public static DynamoPutItem.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - Descriptive identifier for this chainable. This parameter is required.
      Returns:
      a new instance of DynamoPutItem.Builder.

    • comment

      @Stability(Stable) public DynamoPutItem.Builder comment(String comment)
      An optional description for this state.

      Default: - No comment

      Parameters:
      comment - An optional description for this state. This parameter is required.
      Returns:
      this

    • credentials

      @Stability(Stable) public DynamoPutItem.Builder credentials(Credentials credentials)
      Credentials for an IAM Role that the State Machine assumes for executing the task.

      This enables cross-account resource invocations.

      Default: - None (Task is executed using the State Machine's execution role)

      Parameters:
      credentials - Credentials for an IAM Role that the State Machine assumes for executing the task. This parameter is required.
      Returns:
      this
      See Also:

    • heartbeat

      @Stability(Deprecated) @Deprecated public DynamoPutItem.Builder heartbeat(Duration heartbeat)
      Deprecated.
      use heartbeatTimeout
      (deprecated) Timeout for the heartbeat.

      Default: - None

      Parameters:
      heartbeat - Timeout for the heartbeat. This parameter is required.
      Returns:
      this

    • heartbeatTimeout

      @Stability(Stable) public DynamoPutItem.Builder heartbeatTimeout(Timeout heartbeatTimeout)
      Timeout for the heartbeat.

      [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

      Default: - None

      Parameters:
      heartbeatTimeout - Timeout for the heartbeat. This parameter is required.
      Returns:
      this

    • inputPath

      @Stability(Stable) public DynamoPutItem.Builder inputPath(String 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 {}.

      Default: - The entire task input (JSON path '$')

      Parameters:
      inputPath - JSONPath expression to select part of the state to be the input to this state. This parameter is required.
      Returns:
      this

    • integrationPattern

      @Stability(Stable) public DynamoPutItem.Builder integrationPattern(IntegrationPattern 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.

      Default: - `IntegrationPattern.REQUEST_RESPONSE` for most tasks. `IntegrationPattern.RUN_JOB` for the following exceptions: `BatchSubmitJob`, `EmrAddStep`, `EmrCreateCluster`, `EmrTerminationCluster`, and `EmrContainersStartJobRun`.

      Parameters:
      integrationPattern - AWS Step Functions integrates with services directly in the Amazon States Language. This parameter is required.
      Returns:
      this
      See Also:

    • outputPath

      @Stability(Stable) public DynamoPutItem.Builder outputPath(String 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 {}.

      Default: - The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path '$')

      Parameters:
      outputPath - JSONPath expression to select select a portion of the state output to pass to the next state. This parameter is required.
      Returns:
      this

    • resultPath

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

      Default: - Replaces the entire input with the result (JSON path '$')

      Parameters:
      resultPath - JSONPath expression to indicate where to inject the state's output. This parameter is required.
      Returns:
      this

    • resultSelector

      @Stability(Stable) public DynamoPutItem.Builder resultSelector(Map<String,? extends Object> 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.

      Default: - None

      Parameters:
      resultSelector - The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. This parameter is required.
      Returns:
      this
      See Also:

    • stateName

      @Stability(Stable) public DynamoPutItem.Builder stateName(String stateName)
      Optional name for this state.

      Default: - The construct ID will be used as state name

      Parameters:
      stateName - Optional name for this state. This parameter is required.
      Returns:
      this

    • taskTimeout

      @Stability(Stable) public DynamoPutItem.Builder taskTimeout(Timeout taskTimeout)
      Timeout for the task.

      [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

      Default: - None

      Parameters:
      taskTimeout - Timeout for the task. This parameter is required.
      Returns:
      this

    • timeout

      @Stability(Deprecated) @Deprecated public DynamoPutItem.Builder timeout(Duration timeout)
      Deprecated.
      use taskTimeout
      (deprecated) Timeout for the task.

      Default: - None

      Parameters:
      timeout - Timeout for the task. This parameter is required.
      Returns:
      this

    • item

      @Stability(Stable) public DynamoPutItem.Builder item(Map<String,? extends DynamoAttributeValue> item)
      A map of attribute name/value pairs, one for each attribute.

      Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.

      Parameters:
      item - A map of attribute name/value pairs, one for each attribute. This parameter is required.
      Returns:
      this
      See Also:

    • table

      @Stability(Stable) public DynamoPutItem.Builder table(ITable table)
      The name of the table where the item should be written .

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

    • conditionExpression

      @Stability(Stable) public DynamoPutItem.Builder conditionExpression(String conditionExpression)
      A condition that must be satisfied in order for a conditional PutItem operation to succeed.

      Default: - No condition expression

      Parameters:
      conditionExpression - A condition that must be satisfied in order for a conditional PutItem operation to succeed. This parameter is required.
      Returns:
      this
      See Also:

    • expressionAttributeNames

      @Stability(Stable) public DynamoPutItem.Builder expressionAttributeNames(Map<String,String> expressionAttributeNames)
      One or more substitution tokens for attribute names in an expression.

      Default: - No expression attribute names

      Parameters:
      expressionAttributeNames - One or more substitution tokens for attribute names in an expression. This parameter is required.
      Returns:
      this
      See Also:

    • expressionAttributeValues

      @Stability(Stable) public DynamoPutItem.Builder expressionAttributeValues(Map<String,? extends DynamoAttributeValue> expressionAttributeValues)
      One or more values that can be substituted in an expression.

      Default: - No expression attribute values

      Parameters:
      expressionAttributeValues - One or more values that can be substituted in an expression. This parameter is required.
      Returns:
      this
      See Also:

    • returnConsumedCapacity

      @Stability(Stable) public DynamoPutItem.Builder returnConsumedCapacity(DynamoConsumedCapacity returnConsumedCapacity)
      Determines the level of detail about provisioned throughput consumption that is returned in the response.

      Default: DynamoConsumedCapacity.NONE

      Parameters:
      returnConsumedCapacity - Determines the level of detail about provisioned throughput consumption that is returned in the response. This parameter is required.
      Returns:
      this
      See Also:

    • returnItemCollectionMetrics

      @Stability(Stable) public DynamoPutItem.Builder returnItemCollectionMetrics(DynamoItemCollectionMetrics returnItemCollectionMetrics)
      The item collection metrics to returned in the response.

      Default: DynamoItemCollectionMetrics.NONE

      Parameters:
      returnItemCollectionMetrics - The item collection metrics to returned in the response. This parameter is required.
      Returns:
      this
      See Also:

    • returnValues

      @Stability(Stable) public DynamoPutItem.Builder returnValues(DynamoReturnValues returnValues)
      Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request.

      Default: DynamoReturnValues.NONE

      Parameters:
      returnValues - Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request. This parameter is required.
      Returns:
      this
      See Also:

    • build

      @Stability(Stable) public DynamoPutItem build()
      Specified by:
      build in interface software.amazon.jsii.Builder<DynamoPutItem>
      Returns:
      a newly built instance of DynamoPutItem.