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

Class DynamoGetItem.Builder

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

  • Method Details

    • create

      @Stability(Stable) public static DynamoGetItem.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 DynamoGetItem.Builder.

    • comment

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

    • key

      @Stability(Stable) public DynamoGetItem.Builder key(Map<String,? extends DynamoAttributeValue> key)
      Primary key of the item to retrieve.

      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.

      Parameters:
      key - Primary key of the item to retrieve. This parameter is required.
      Returns:
      this
      See Also:

    • table

      @Stability(Stable) public DynamoGetItem.Builder table(ITable table)
      The name of the table containing the requested item.

      Parameters:
      table - The name of the table containing the requested item. This parameter is required.
      Returns:
      this

    • consistentRead

      @Stability(Stable) public DynamoGetItem.Builder consistentRead(Boolean consistentRead)
      Determines the read consistency model: If set to true, then the operation uses strongly consistent reads;

      otherwise, the operation uses eventually consistent reads.

      Default: false

      Parameters:
      consistentRead - Determines the read consistency model: If set to true, then the operation uses strongly consistent reads;. This parameter is required.
      Returns:
      this

    • expressionAttributeNames

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

      Default: - No expression attributes

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

    • projectionExpression

      @Stability(Stable) public DynamoGetItem.Builder projectionExpression(List<? extends DynamoProjectionExpression> 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.

      Default: - No projection expression

      Parameters:
      projectionExpression - An array of DynamoProjectionExpression that identifies one or more attributes to retrieve from the table. This parameter is required.
      Returns:
      this
      See Also:

    • returnConsumedCapacity

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

    • build

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