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

Interface AthenaStartQueryExecutionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, TaskStateBaseProps

All Known Implementing Classes:

AthenaStartQueryExecutionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-24T21:00:38.014Z")
@Stability(Stable)
public interface AthenaStartQueryExecutionProps
extends software.amazon.jsii.JsiiSerializable, TaskStateBaseProps

Properties for starting a Query Execution.

Example:

 AthenaStartQueryExecution startQueryExecutionJob = AthenaStartQueryExecution.Builder.create(this, "Start Athena Query")
         .queryString(JsonPath.stringAt("$.queryString"))
         .queryExecutionContext(QueryExecutionContext.builder()
                 .databaseName("mydatabase")
                 .build())
         .resultConfiguration(ResultConfiguration.builder()
                 .encryptionConfiguration(EncryptionConfiguration.builder()
                         .encryptionOption(EncryptionOption.S3_MANAGED)
                         .build())
                 .outputLocation(Location.builder()
                         .bucketName("query-results-bucket")
                         .objectKey("folder")
                         .build())
                 .build())
         .executionParameters(List.of("param1", "param2"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	AthenaStartQueryExecutionProps.Builder	A builder for AthenaStartQueryExecutionProps
static final class	AthenaStartQueryExecutionProps.Jsii$Proxy	An implementation for AthenaStartQueryExecutionProps

Method Summary

Modifier and Type	Method	Description
static AthenaStartQueryExecutionProps.Builder	builder()
default String	getClientRequestToken()	Unique string string to ensure idempotence.
default List<String>	getExecutionParameters()	A list of values for the parameters in a query.
default QueryExecutionContext	getQueryExecutionContext()	Database within which query executes.
String	getQueryString()	Query that will be started.
default ResultConfiguration	getResultConfiguration()	Configuration on how and where to save query.
default String	getWorkGroup()	Configuration on how and where to save query.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.TaskStateBaseProps

getComment, getCredentials, getHeartbeat, getHeartbeatTimeout, getInputPath, getIntegrationPattern, getOutputPath, getResultPath, getResultSelector, getStateName, getTaskTimeout, getTimeout

Method Details

getQueryString

@Stability(Stable)
@NotNull
String getQueryString()

Query that will be started.

getClientRequestToken

@Stability(Stable)
@Nullable
default String getClientRequestToken()

Unique string string to ensure idempotence.

Default: - No client request token

getExecutionParameters

@Stability(Stable)
@Nullable
default List<String> getExecutionParameters()

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

getQueryExecutionContext

@Stability(Stable)
@Nullable
default QueryExecutionContext getQueryExecutionContext()

Database within which query executes.

Default: - No query execution context

getResultConfiguration

@Stability(Stable)
@Nullable
default ResultConfiguration getResultConfiguration()

Configuration on how and where to save query.

Default: - No result configuration

getWorkGroup

@Stability(Stable)
@Nullable
default String getWorkGroup()

Configuration on how and where to save query.

Default: - No work group

builder

@Stability(Stable)
static AthenaStartQueryExecutionProps.Builder builder()

Returns:

a AthenaStartQueryExecutionProps.Builder of AthenaStartQueryExecutionProps