software.amazon.awscdk.services.stepfunctions.tasks

Interface QueryExecutionContext

All Known Implementing Classes:

QueryExecutionContext.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-28T18:14:45.538Z")
public interface QueryExecutionContext

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

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/athena/latest/APIReference/API_QueryExecutionContext.html

Nested Class Summary

Nested Classes

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

Method Summary

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

Method Detail

getCatalogName

default java.lang.String getCatalogName()

Name of catalog used in query execution.

Default: - No catalog

getDatabaseName

default java.lang.String getDatabaseName()

Name of database used in query execution.

Default: - No database

builder

static QueryExecutionContext.Builder builder()

Returns:

a QueryExecutionContext.Builder of QueryExecutionContext