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

Interface ResultConfiguration

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ResultConfiguration.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:14.619Z")
@Stability(Stable)
public interface ResultConfiguration
extends software.amazon.jsii.JsiiSerializable

Location of query result along with S3 bucket configuration.

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_ResultConfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ResultConfiguration.Builder	builder()
default EncryptionConfiguration	getEncryptionConfiguration()	Encryption option used if enabled in S3.
default Location	getOutputLocation()	S3 path of query results.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEncryptionConfiguration

@Stability(Stable)
@Nullable
default EncryptionConfiguration getEncryptionConfiguration()

Encryption option used if enabled in S3.

Default: - SSE_S3 encrpytion is enabled with default encryption key

getOutputLocation

@Stability(Stable)
@Nullable
default Location getOutputLocation()

S3 path of query results.

Example value: s3://query-results-bucket/folder/

Default: - Query Result Location set in Athena settings for this workgroup

builder

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

Returns:

a ResultConfiguration.Builder of ResultConfiguration