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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.440Z")
 @Stability(value=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())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static AthenaStartQueryExecutionProps.Builder	builder()
default String	getClientRequestToken() Unique string string to ensure idempotence.
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.awscdk.services.stepfunctions.TaskStateBaseProps

getComment, getHeartbeat, getInputPath, getIntegrationPattern, getOutputPath, getResultPath, getResultSelector, getTimeout

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getQueryString

@Stability(value=Stable)
 @NotNull
String getQueryString()

Query that will be started.

getClientRequestToken

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

Unique string string to ensure idempotence.

Default: - No client request token

getQueryExecutionContext

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

Database within which query executes.

Default: - No query execution context

getResultConfiguration

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

Configuration on how and where to save query.

Default: - No result configuration

getWorkGroup

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

Configuration on how and where to save query.

Default: - No work group

builder

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

Specified by:

builder in interface TaskStateBaseProps

Returns:

a AthenaStartQueryExecutionProps.Builder of AthenaStartQueryExecutionProps