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(value=Stable)
public static final class AthenaStartQueryExecution.Builder
extends Object
implements software.amazon.jsii.Builder<AthenaStartQueryExecution>

A fluent builder for AthenaStartQueryExecution.

Method Summary

Modifier and Type	Method and Description
AthenaStartQueryExecution	build()
AthenaStartQueryExecution.Builder	clientRequestToken(String clientRequestToken) Unique string string to ensure idempotence.
AthenaStartQueryExecution.Builder	comment(String comment) An optional description for this state.
static AthenaStartQueryExecution.Builder	create(software.constructs.Construct scope, String id)
AthenaStartQueryExecution.Builder	heartbeat(Duration heartbeat) Timeout for the heartbeat.
AthenaStartQueryExecution.Builder	inputPath(String inputPath) JSONPath expression to select part of the state to be the input to this state.
AthenaStartQueryExecution.Builder	integrationPattern(IntegrationPattern integrationPattern) AWS Step Functions integrates with services directly in the Amazon States Language.
AthenaStartQueryExecution.Builder	outputPath(String outputPath) JSONPath expression to select select a portion of the state output to pass to the next state.
AthenaStartQueryExecution.Builder	queryExecutionContext(QueryExecutionContext queryExecutionContext) Database within which query executes.
AthenaStartQueryExecution.Builder	queryString(String queryString) Query that will be started.
AthenaStartQueryExecution.Builder	resultConfiguration(ResultConfiguration resultConfiguration) Configuration on how and where to save query.
AthenaStartQueryExecution.Builder	resultPath(String resultPath) JSONPath expression to indicate where to inject the state's output.
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.
AthenaStartQueryExecution.Builder	timeout(Duration timeout) Timeout for the state machine.
AthenaStartQueryExecution.Builder	workGroup(String workGroup) Configuration on how and where to save query.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static AthenaStartQueryExecution.Builder create(software.constructs.Construct scope,
                                                                                String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of AthenaStartQueryExecution.Builder.

comment

@Stability(value=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

heartbeat

@Stability(value=Stable)
public AthenaStartQueryExecution.Builder heartbeat(Duration heartbeat)

Timeout for the heartbeat.

Default: - None

Parameters:

heartbeat - Timeout for the heartbeat. This parameter is required.

Returns:

this

inputPath

@Stability(value=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(value=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

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:

https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token

outputPath

@Stability(value=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(value=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(value=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:

https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector

timeout

@Stability(value=Stable)
public AthenaStartQueryExecution.Builder timeout(Duration timeout)

Timeout for the state machine.

Default: - None

Parameters:

timeout - Timeout for the state machine. This parameter is required.

Returns:

this

queryString

@Stability(value=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(value=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

queryExecutionContext

@Stability(value=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(value=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

workGroup

@Stability(value=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(value=Stable)
public AthenaStartQueryExecution build()

Specified by:

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