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

Interface QueryExecutionContext

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

QueryExecutionContext.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-02T15:58:34.276Z")
@Stability(Stable)
public interface QueryExecutionContext
extends software.amazon.jsii.JsiiSerializable

Database and data catalog context in which the query execution occurs.

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();
 

See Also:

• https://docs.aws.amazon.com/athena/latest/APIReference/API_QueryExecutionContext.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static QueryExecutionContext.Builder	builder()
default String	getCatalogName()	Name of catalog used in query execution.
default String	getDatabaseName()	Name of database used in query execution.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCatalogName

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

Name of catalog used in query execution.

Default: - No catalog

getDatabaseName

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

Name of database used in query execution.

Default: - No database

builder

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

Returns:

a QueryExecutionContext.Builder of QueryExecutionContext