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

Class AthenaStartQueryExecution.Builder

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

  • Method Details

    • create

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

    • comment

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

    • queryString

      @Stability(Stable) public AthenaStartQueryExecution.Builder queryString(String queryString)
      Query that will be started.

      Parameters:
      queryString - Query that will be started. This parameter is required.
      Returns:
      this

    • clientRequestToken

      @Stability(Stable) public AthenaStartQueryExecution.Builder clientRequestToken(String clientRequestToken)
      Unique string string to ensure idempotence.

      Default: - No client request token

      Parameters:
      clientRequestToken - Unique string string to ensure idempotence. This parameter is required.
      Returns:
      this

    • executionParameters

      @Stability(Stable) public AthenaStartQueryExecution.Builder executionParameters(List<String> executionParameters)
      A list of values for the parameters in a query.

      The values are applied sequentially to the parameters in the query in the order in which the parameters occur.

      Default: - No parameters

      Parameters:
      executionParameters - A list of values for the parameters in a query. This parameter is required.
      Returns:
      this

    • queryExecutionContext

      @Stability(Stable) public AthenaStartQueryExecution.Builder queryExecutionContext(QueryExecutionContext queryExecutionContext)
      Database within which query executes.

      Default: - No query execution context

      Parameters:
      queryExecutionContext - Database within which query executes. This parameter is required.
      Returns:
      this

    • resultConfiguration

      @Stability(Stable) public AthenaStartQueryExecution.Builder resultConfiguration(ResultConfiguration resultConfiguration)
      Configuration on how and where to save query.

      Default: - No result configuration

      Parameters:
      resultConfiguration - Configuration on how and where to save query. This parameter is required.
      Returns:
      this

    • resultReuseConfigurationMaxAge

      @Stability(Stable) public AthenaStartQueryExecution.Builder resultReuseConfigurationMaxAge(Duration resultReuseConfigurationMaxAge)
      Specifies, in minutes, the maximum age of a previous query result that Athena should consider for reuse.

      Default: - Query results are not reused

      Parameters:
      resultReuseConfigurationMaxAge - Specifies, in minutes, the maximum age of a previous query result that Athena should consider for reuse. This parameter is required.
      Returns:
      this

    • workGroup

      @Stability(Stable) public AthenaStartQueryExecution.Builder workGroup(String workGroup)
      Configuration on how and where to save query.

      Default: - No work group

      Parameters:
      workGroup - Configuration on how and where to save query. This parameter is required.
      Returns:
      this

    • build

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