software.amazon.awscdk.services.athena

Interface CfnWorkGroup.ResultConfigurationUpdatesProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWorkGroup.ResultConfigurationUpdatesProperty.Jsii$Proxy

Enclosing class:

CfnWorkGroup

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

The information about the updates in the query results, such as output location and encryption configuration for the query results.

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.*;
 ResultConfigurationUpdatesProperty resultConfigurationUpdatesProperty = ResultConfigurationUpdatesProperty.builder()
         .encryptionConfiguration(EncryptionConfigurationProperty.builder()
                 .encryptionOption("encryptionOption")
                 // the properties below are optional
                 .kmsKey("kmsKey")
                 .build())
         .outputLocation("outputLocation")
         .removeEncryptionConfiguration(false)
         .removeOutputLocation(false)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnWorkGroup.ResultConfigurationUpdatesProperty.Builder	builder()
default Object	getEncryptionConfiguration() The encryption configuration for the query results.
default String	getOutputLocation() The location in Amazon S3 where your query results are stored, such as `s3://path/to/query/bucket/` .
default Object	getRemoveEncryptionConfiguration() If set to "true", indicates that the previously-specified encryption configuration (also known as the client-side setting) for queries in this workgroup should be ignored and set to null.
default Object	getRemoveOutputLocation() If set to "true", indicates that the previously-specified query results location (also known as a client-side setting) for queries in this workgroup should be ignored and set to null.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getEncryptionConfiguration

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

The encryption configuration for the query results.

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/` .

For more information, see Query Results If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup. The "workgroup settings override" is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See EnforceWorkGroupConfiguration .

getRemoveEncryptionConfiguration

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

If set to "true", indicates that the previously-specified encryption configuration (also known as the client-side setting) for queries in this workgroup should be ignored and set to null.

If set to "false" or not set, and a value is present in the EncryptionConfiguration in ResultConfigurationUpdates (the client-side setting), the EncryptionConfiguration in the workgroup's ResultConfiguration will be updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings .

getRemoveOutputLocation

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

If set to "true", indicates that the previously-specified query results location (also known as a client-side setting) for queries in this workgroup should be ignored and set to null.

If set to "false" or not set, and a value is present in the OutputLocation in ResultConfigurationUpdates (the client-side setting), the OutputLocation in the workgroup's ResultConfiguration will be updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings .

builder

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

Returns:

a CfnWorkGroup.ResultConfigurationUpdatesProperty.Builder of CfnWorkGroup.ResultConfigurationUpdatesProperty