software.amazon.awscdk.services.athena

Interface CfnWorkGroup.ResultConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWorkGroup.ResultConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnWorkGroup

@Stability(value=Stable)
public static interface CfnWorkGroup.ResultConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

The location in Amazon S3 where query results are stored and the encryption option, if any, used for query results.

These are known as "client-side settings". If workgroup settings override client-side settings, then the query uses the workgroup settings.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.athena.*;
 ResultConfigurationProperty resultConfigurationProperty = ResultConfigurationProperty.builder()
         .encryptionConfiguration(EncryptionConfigurationProperty.builder()
                 .encryptionOption("encryptionOption")
                 // the properties below are optional
                 .kmsKey("kmsKey")
                 .build())
         .outputLocation("outputLocation")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnWorkGroup.ResultConfigurationProperty.Builder	builder()
default Object	getEncryptionConfiguration() If query results are encrypted in Amazon S3, indicates the encryption option used (for example, `SSE_KMS` or `CSE_KMS` ) and key information.
default String	getOutputLocation() The location in Amazon S3 where your query results are stored, such as `s3://path/to/query/bucket/` .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getEncryptionConfiguration

@Stability(value=Stable)
 @Nullable
default Object getEncryptionConfiguration()

If query results are encrypted in Amazon S3, indicates the encryption option used (for example, `SSE_KMS` or `CSE_KMS` ) and key information.

This is a client-side setting. If workgroup settings override client-side settings, then the query uses the encryption configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings .

getOutputLocation

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

The location in Amazon S3 where your query results are stored, such as `s3://path/to/query/bucket/` .

To run a query, you must specify the query results location using either a client-side setting for individual queries or a location specified by the workgroup. If workgroup settings override client-side settings, then the query uses the location specified for the workgroup. If no query location is set, Athena issues an error. For more information, see Working with Query Results, Output Files, and Query History and EnforceWorkGroupConfiguration .

builder

@Stability(value=Stable)
static CfnWorkGroup.ResultConfigurationProperty.Builder builder()

Returns:

a CfnWorkGroup.ResultConfigurationProperty.Builder of CfnWorkGroup.ResultConfigurationProperty