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

Interface AthenaStartQueryExecutionProps

All Superinterfaces:
AssignableStateOptions, software.amazon.jsii.JsiiSerializable, JsonataCommonOptions, JsonPathCommonOptions, StateBaseProps, TaskStateBaseOptions, TaskStateBaseProps
All Known Implementing Classes:
AthenaStartQueryExecutionProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-04T09:27:51.288Z") @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("amzn-s3-demo-bucket")
                         .objectKey("folder")
                         .build())
                 .build())
         .executionParameters(List.of("param1", "param2"))
         .build();

  • 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

    • getResultReuseConfigurationMaxAge

      @Stability(Stable) @Nullable default Duration getResultReuseConfigurationMaxAge()
      Specifies, in minutes, the maximum age of a previous query result that Athena should consider for reuse.

      Default: - Query results are not reused

    • 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