Package software.amazon.awscdk.cfnpropertymixins.services.athena

Class CfnWorkGroupPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.athena.CfnWorkGroupPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:56.095Z")
@Stability(Stable)
public class CfnWorkGroupPropsMixin
extends Mixin
implements software.constructs.IMixin

The AWS::Athena::WorkGroup resource specifies an Amazon Athena workgroup, which contains a name, description, creation time, state, and other configuration, listed under WorkGroupConfiguration .

Each workgroup enables you to isolate queries for you or your group from other queries in the same account. For more information, see CreateWorkGroup in the Amazon Athena API Reference .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.athena.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnWorkGroupPropsMixin cfnWorkGroupPropsMixin = CfnWorkGroupPropsMixin.Builder.create(CfnWorkGroupMixinProps.builder()
         .description("description")
         .name("name")
         .recursiveDeleteOption(false)
         .state("state")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .workGroupConfiguration(WorkGroupConfigurationProperty.builder()
                 .additionalConfiguration("additionalConfiguration")
                 .bytesScannedCutoffPerQuery(123)
                 .customerContentEncryptionConfiguration(CustomerContentEncryptionConfigurationProperty.builder()
                         .kmsKey("kmsKey")
                         .build())
                 .enforceWorkGroupConfiguration(false)
                 .engineConfiguration(EngineConfigurationProperty.builder()
                         .additionalConfigs(Map.of(
                                 "additionalConfigsKey", "additionalConfigs"))
                         .classifications(List.of(ClassificationProperty.builder()
                                 .name("name")
                                 .properties(Map.of(
                                         "propertiesKey", "properties"))
                                 .build()))
                         .coordinatorDpuSize(123)
                         .defaultExecutorDpuSize(123)
                         .maxConcurrentDpus(123)
                         .sparkProperties(Map.of(
                                 "sparkPropertiesKey", "sparkProperties"))
                         .build())
                 .engineVersion(EngineVersionProperty.builder()
                         .effectiveEngineVersion("effectiveEngineVersion")
                         .selectedEngineVersion("selectedEngineVersion")
                         .build())
                 .executionRole("executionRole")
                 .managedQueryResultsConfiguration(ManagedQueryResultsConfigurationProperty.builder()
                         .enabled(false)
                         .encryptionConfiguration(ManagedStorageEncryptionConfigurationProperty.builder()
                                 .kmsKey("kmsKey")
                                 .build())
                         .build())
                 .monitoringConfiguration(MonitoringConfigurationProperty.builder()
                         .cloudWatchLoggingConfiguration(CloudWatchLoggingConfigurationProperty.builder()
                                 .enabled(false)
                                 .logGroup("logGroup")
                                 .logStreamNamePrefix("logStreamNamePrefix")
                                 .logTypes(Map.of(
                                         "logTypesKey", List.of("logTypes")))
                                 .build())
                         .managedLoggingConfiguration(ManagedLoggingConfigurationProperty.builder()
                                 .enabled(false)
                                 .kmsKey("kmsKey")
                                 .build())
                         .s3LoggingConfiguration(S3LoggingConfigurationProperty.builder()
                                 .enabled(false)
                                 .kmsKey("kmsKey")
                                 .logLocation("logLocation")
                                 .build())
                         .build())
                 .publishCloudWatchMetricsEnabled(false)
                 .requesterPaysEnabled(false)
                 .resultConfiguration(ResultConfigurationProperty.builder()
                         .aclConfiguration(AclConfigurationProperty.builder()
                                 .s3AclOption("s3AclOption")
                                 .build())
                         .encryptionConfiguration(EncryptionConfigurationProperty.builder()
                                 .encryptionOption("encryptionOption")
                                 .kmsKey("kmsKey")
                                 .build())
                         .expectedBucketOwner("expectedBucketOwner")
                         .outputLocation("outputLocation")
                         .build())
                 .build())
         .workGroupConfigurationUpdates(WorkGroupConfigurationUpdatesProperty.builder()
                 .additionalConfiguration("additionalConfiguration")
                 .bytesScannedCutoffPerQuery(123)
                 .customerContentEncryptionConfiguration(CustomerContentEncryptionConfigurationProperty.builder()
                         .kmsKey("kmsKey")
                         .build())
                 .enforceWorkGroupConfiguration(false)
                 .engineConfiguration(EngineConfigurationProperty.builder()
                         .additionalConfigs(Map.of(
                                 "additionalConfigsKey", "additionalConfigs"))
                         .classifications(List.of(ClassificationProperty.builder()
                                 .name("name")
                                 .properties(Map.of(
                                         "propertiesKey", "properties"))
                                 .build()))
                         .coordinatorDpuSize(123)
                         .defaultExecutorDpuSize(123)
                         .maxConcurrentDpus(123)
                         .sparkProperties(Map.of(
                                 "sparkPropertiesKey", "sparkProperties"))
                         .build())
                 .engineVersion(EngineVersionProperty.builder()
                         .effectiveEngineVersion("effectiveEngineVersion")
                         .selectedEngineVersion("selectedEngineVersion")
                         .build())
                 .executionRole("executionRole")
                 .managedQueryResultsConfiguration(ManagedQueryResultsConfigurationProperty.builder()
                         .enabled(false)
                         .encryptionConfiguration(ManagedStorageEncryptionConfigurationProperty.builder()
                                 .kmsKey("kmsKey")
                                 .build())
                         .build())
                 .monitoringConfiguration(MonitoringConfigurationProperty.builder()
                         .cloudWatchLoggingConfiguration(CloudWatchLoggingConfigurationProperty.builder()
                                 .enabled(false)
                                 .logGroup("logGroup")
                                 .logStreamNamePrefix("logStreamNamePrefix")
                                 .logTypes(Map.of(
                                         "logTypesKey", List.of("logTypes")))
                                 .build())
                         .managedLoggingConfiguration(ManagedLoggingConfigurationProperty.builder()
                                 .enabled(false)
                                 .kmsKey("kmsKey")
                                 .build())
                         .s3LoggingConfiguration(S3LoggingConfigurationProperty.builder()
                                 .enabled(false)
                                 .kmsKey("kmsKey")
                                 .logLocation("logLocation")
                                 .build())
                         .build())
                 .publishCloudWatchMetricsEnabled(false)
                 .removeBytesScannedCutoffPerQuery(false)
                 .removeCustomerContentEncryptionConfiguration(false)
                 .requesterPaysEnabled(false)
                 .resultConfigurationUpdates(ResultConfigurationUpdatesProperty.builder()
                         .aclConfiguration(AclConfigurationProperty.builder()
                                 .s3AclOption("s3AclOption")
                                 .build())
                         .encryptionConfiguration(EncryptionConfigurationProperty.builder()
                                 .encryptionOption("encryptionOption")
                                 .kmsKey("kmsKey")
                                 .build())
                         .expectedBucketOwner("expectedBucketOwner")
                         .outputLocation("outputLocation")
                         .removeAclConfiguration(false)
                         .removeEncryptionConfiguration(false)
                         .removeExpectedBucketOwner(false)
                         .removeOutputLocation(false)
                         .build())
                 .build())
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-workgroup.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnWorkGroupPropsMixin.AclConfigurationProperty	Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results, including data files inserted by Athena as the result of statements like CTAS or INSERT INTO.
static final class	CfnWorkGroupPropsMixin.Builder	A fluent builder for CfnWorkGroupPropsMixin.
static interface	CfnWorkGroupPropsMixin.ClassificationProperty	A classification refers to a set of specific configurations.
static interface	CfnWorkGroupPropsMixin.CloudWatchLoggingConfigurationProperty	Configuration settings for delivering logs to Amazon CloudWatch log groups.
static interface	CfnWorkGroupPropsMixin.CustomerContentEncryptionConfigurationProperty	Specifies the customer managed KMS key that is used to encrypt the user's data stores in Athena.
static interface	CfnWorkGroupPropsMixin.EncryptionConfigurationProperty	If query results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE_KMS or CSE_KMS ) and key information.
static interface	CfnWorkGroupPropsMixin.EngineConfigurationProperty	The engine configuration for the workgroup, which includes the minimum/maximum number of Data Processing Units (DPU) that queries should use when running in provisioned capacity.
static interface	CfnWorkGroupPropsMixin.EngineVersionProperty	The Athena engine version for running queries, or the PySpark engine version for running sessions.
static interface	CfnWorkGroupPropsMixin.ManagedLoggingConfigurationProperty	Configuration settings for delivering logs to Amazon S3 buckets.
static interface	CfnWorkGroupPropsMixin.ManagedQueryResultsConfigurationProperty	The configuration for storing results in Athena owned storage, which includes whether this feature is enabled;
static interface	CfnWorkGroupPropsMixin.ManagedStorageEncryptionConfigurationProperty	Indicates the encryption configuration for Athena Managed Storage.
static interface	CfnWorkGroupPropsMixin.MonitoringConfigurationProperty	Contains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc.
static interface	CfnWorkGroupPropsMixin.ResultConfigurationProperty	The location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query and calculation results.
static interface	CfnWorkGroupPropsMixin.ResultConfigurationUpdatesProperty	The information about the updates in the query results, such as output location and encryption configuration for the query results.
static interface	CfnWorkGroupPropsMixin.S3LoggingConfigurationProperty	Configuration settings for delivering logs to Amazon S3 buckets.
static interface	CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty	The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether Amazon CloudWatch Metrics are enabled for the workgroup, and the limit for the amount of bytes scanned (cutoff) per query, if it is specified.
static interface	CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty	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.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnWorkGroupPropsMixin(CfnWorkGroupMixinProps props)	Create a mixin to apply properties to AWS::Athena::WorkGroup.
	CfnWorkGroupPropsMixin(CfnWorkGroupMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::Athena::WorkGroup.
protected	CfnWorkGroupPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnWorkGroupPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnWorkGroupMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnWorkGroupPropsMixin

protected CfnWorkGroupPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnWorkGroupPropsMixin

protected CfnWorkGroupPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnWorkGroupPropsMixin

@Stability(Stable)
public CfnWorkGroupPropsMixin(@NotNull
 CfnWorkGroupMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::Athena::WorkGroup.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnWorkGroupPropsMixin

@Stability(Stable)
public CfnWorkGroupPropsMixin(@NotNull
 CfnWorkGroupMixinProps props)

Create a mixin to apply properties to AWS::Athena::WorkGroup.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnWorkGroupMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()