software.amazon.awscdk.services.stepfunctions.tasks

Class AthenaStartQueryExecution

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.services.stepfunctions.State

software.amazon.awscdk.services.stepfunctions.TaskStateBase

software.amazon.awscdk.services.stepfunctions.tasks.AthenaStartQueryExecution

All Implemented Interfaces:

IDependable, IChainable, INextable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.72.0 (build 4b8828b)",
           date="2023-01-03T16:22:40.436Z")
 @Stability(value=Stable)
public class AthenaStartQueryExecution
extends TaskStateBase

Start an Athena Query as a Task.

Example:

 AthenaStartQueryExecution startQueryExecutionJob = AthenaStartQueryExecution.Builder.create(this, "Athena Start Query")
         .queryString(JsonPath.format("select contacts where year={};", JsonPath.stringAt("$.year")))
         .queryExecutionContext(QueryExecutionContext.builder()
                 .databaseName("interactions")
                 .build())
         .resultConfiguration(ResultConfiguration.builder()
                 .encryptionConfiguration(EncryptionConfiguration.builder()
                         .encryptionOption(EncryptionOption.S3_MANAGED)
                         .build())
                 .outputLocation(Location.builder()
                         .bucketName("mybucket")
                         .objectKey("myprefix")
                         .build())
                 .build())
         .integrationPattern(IntegrationPattern.RUN_JOB)
         .build();
 

See Also:

https://docs.aws.amazon.com/step-functions/latest/dg/connect-athena.html

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AthenaStartQueryExecution.Builder A fluent builder for AthenaStartQueryExecution.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.INextable

INextable.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.IChainable

IChainable.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
	AthenaStartQueryExecution(software.constructs.Construct scope, String id, AthenaStartQueryExecutionProps props)
protected	AthenaStartQueryExecution(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	AthenaStartQueryExecution(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected TaskMetricsConfig	getTaskMetrics()
protected List<PolicyStatement>	getTaskPolicies()

Methods inherited from class software.amazon.awscdk.services.stepfunctions.TaskStateBase

addCatch, addCatch, addRetry, addRetry, getEndStates, metric, metric, metricFailed, metricFailed, metricHeartbeatTimedOut, metricHeartbeatTimedOut, metricRunTime, metricRunTime, metricScheduled, metricScheduled, metricScheduleTime, metricScheduleTime, metricStarted, metricStarted, metricSucceeded, metricSucceeded, metricTime, metricTime, metricTimedOut, metricTimedOut, next, toStateJson, whenBoundToGraph

Methods inherited from class software.amazon.awscdk.services.stepfunctions.State

addBranch, addChoice, addIterator, addPrefix, bindToGraph, filterNextables, findReachableEndStates, findReachableEndStates, findReachableStates, findReachableStates, getBranches, getComment, getDefaultChoice, getId, getInputPath, getIteration, getOutputPath, getParameters, getResultPath, getResultSelector, getStartState, getStateId, makeDefault, makeNext, prefixStates, renderBranches, renderChoices, renderInputOutput, renderIterator, renderNextEnd, renderResultSelector, renderRetryCatch, setDefaultChoice, setIteration

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.constructs.Construct

toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

AthenaStartQueryExecution

protected AthenaStartQueryExecution(software.amazon.jsii.JsiiObjectRef objRef)

AthenaStartQueryExecution

protected AthenaStartQueryExecution(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

AthenaStartQueryExecution

@Stability(value=Stable)
public AthenaStartQueryExecution(@NotNull
                                                          software.constructs.Construct scope,
                                                          @NotNull
                                                          String id,
                                                          @NotNull
                                                          AthenaStartQueryExecutionProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

getTaskMetrics

@Stability(value=Stable)
 @Nullable
protected TaskMetricsConfig getTaskMetrics()

Specified by:

getTaskMetrics in class TaskStateBase

getTaskPolicies

@Stability(value=Stable)
 @Nullable
protected List<PolicyStatement> getTaskPolicies()

Specified by:

getTaskPolicies in class TaskStateBase