software.amazon.awscdk.services.athena

Interface CfnWorkGroup.WorkGroupConfigurationUpdatesProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWorkGroup.WorkGroupConfigurationUpdatesProperty.Jsii$Proxy

Enclosing class:

CfnWorkGroup

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

The configuration information that will be updated for this workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, whether the workgroup settings override the client-side settings, and the data usage limit for the amount of bytes scanned per query, if it is specified.

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.*;
 WorkGroupConfigurationUpdatesProperty workGroupConfigurationUpdatesProperty = WorkGroupConfigurationUpdatesProperty.builder()
         .bytesScannedCutoffPerQuery(123)
         .enforceWorkGroupConfiguration(false)
         .engineVersion(EngineVersionProperty.builder()
                 .effectiveEngineVersion("effectiveEngineVersion")
                 .selectedEngineVersion("selectedEngineVersion")
                 .build())
         .publishCloudWatchMetricsEnabled(false)
         .removeBytesScannedCutoffPerQuery(false)
         .requesterPaysEnabled(false)
         .resultConfigurationUpdates(ResultConfigurationUpdatesProperty.builder()
                 .encryptionConfiguration(EncryptionConfigurationProperty.builder()
                         .encryptionOption("encryptionOption")
                         // the properties below are optional
                         .kmsKey("kmsKey")
                         .build())
                 .outputLocation("outputLocation")
                 .removeEncryptionConfiguration(false)
                 .removeOutputLocation(false)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnWorkGroup.WorkGroupConfigurationUpdatesProperty.Builder	builder()
default Number	getBytesScannedCutoffPerQuery() The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
default Object	getEnforceWorkGroupConfiguration() If set to "true", the settings for the workgroup override client-side settings.
default Object	getEngineVersion() The engine version requested when a workgroup is updated.
default Object	getPublishCloudWatchMetricsEnabled() Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.
default Object	getRemoveBytesScannedCutoffPerQuery() Indicates that the data usage control limit per query is removed.
default Object	getRequesterPaysEnabled() If set to `true` , allows members assigned to a workgroup to specify Amazon S3 Requester Pays buckets in queries.
default Object	getResultConfigurationUpdates() The result configuration information about the queries in this workgroup that will be updated.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getBytesScannedCutoffPerQuery

@Stability(value=Stable)
 @Nullable
default Number getBytesScannedCutoffPerQuery()

The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.

No default is defined.

This property currently supports integer types. Support for long values is planned.

getEnforceWorkGroupConfiguration

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

If set to "true", the settings for the workgroup override client-side settings.

If set to "false" client-side settings are used. For more information, see Workgroup Settings Override Client-Side Settings .

getEngineVersion

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

The engine version requested when a workgroup is updated.

After the update, all queries on the workgroup run on the requested engine version. If no value was previously set, the default is Auto. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.

getPublishCloudWatchMetricsEnabled

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

Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.

getRemoveBytesScannedCutoffPerQuery

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

Indicates that the data usage control limit per query is removed.

See BytesScannedCutoffPerQuery .

getRequesterPaysEnabled

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

If set to `true` , allows members assigned to a workgroup to specify Amazon S3 Requester Pays buckets in queries.

If set to false , workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false . For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide .

getResultConfigurationUpdates

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

The result configuration information about the queries in this workgroup that will be updated.

Includes the updated results location and an updated option for encrypting query results.

builder

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

Returns:

a CfnWorkGroup.WorkGroupConfigurationUpdatesProperty.Builder of CfnWorkGroup.WorkGroupConfigurationUpdatesProperty