interface WorkGroupConfigurationProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Athena.CfnWorkGroup.WorkGroupConfigurationProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsathena#CfnWorkGroup_WorkGroupConfigurationProperty`
Java	`software.amazon.awscdk.services.athena.CfnWorkGroup.WorkGroupConfigurationProperty`
Python	`aws_cdk.aws_athena.CfnWorkGroup.WorkGroupConfigurationProperty`
TypeScript	`aws-cdk-lib` » `aws_athena` » `CfnWorkGroup` » `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.

The EnforceWorkGroupConfiguration option determines whether workgroup settings override client-side query settings.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_athena as athena } from 'aws-cdk-lib';
const workGroupConfigurationProperty: athena.CfnWorkGroup.WorkGroupConfigurationProperty = {
  additionalConfiguration: 'additionalConfiguration',
  bytesScannedCutoffPerQuery: 123,
  customerContentEncryptionConfiguration: {
    kmsKey: 'kmsKey',
  },
  enforceWorkGroupConfiguration: false,
  engineVersion: {
    effectiveEngineVersion: 'effectiveEngineVersion',
    selectedEngineVersion: 'selectedEngineVersion',
  },
  executionRole: 'executionRole',
  publishCloudWatchMetricsEnabled: false,
  requesterPaysEnabled: false,
  resultConfiguration: {
    aclConfiguration: {
      s3AclOption: 's3AclOption',
    },
    encryptionConfiguration: {
      encryptionOption: 'encryptionOption',

      // the properties below are optional
      kmsKey: 'kmsKey',
    },
    expectedBucketOwner: 'expectedBucketOwner',
    outputLocation: 'outputLocation',
  },
};

Properties

Name	Type	Description
additionalConfiguration?	`string`	Specifies a user defined JSON string that is passed to the session engine.
bytesScannedCutoffPerQuery?	`number`	The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
customerContentEncryptionConfiguration?	`IResolvable` `\|` `CustomerContentEncryptionConfigurationProperty`	Specifies the KMS key that is used to encrypt the user's data stores in Athena.
enforceWorkGroupConfiguration?	`boolean \|` `IResolvable`	If set to "true", the settings for the workgroup override client-side settings.
engineVersion?	`IResolvable` `\|` `EngineVersionProperty`	The engine version that all queries running on the workgroup use.
executionRole?	`string`	Role used to access user resources in an Athena for Apache Spark session.
publishCloudWatchMetricsEnabled?	`boolean \|` `IResolvable`	Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
requesterPaysEnabled?	`boolean \|` `IResolvable`	If set to `true` , allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries.
resultConfiguration?	`IResolvable` `\|` `ResultConfigurationProperty`	Specifies the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results.

additionalConfiguration?

Type: string (optional)

Specifies a user defined JSON string that is passed to the session engine.

bytesScannedCutoffPerQuery?

Type: number (optional)

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.

customerContentEncryptionConfiguration?

Type: IResolvable | CustomerContentEncryptionConfigurationProperty (optional)

Specifies the KMS key that is used to encrypt the user's data stores in Athena.

This setting does not apply to Athena SQL workgroups.

enforceWorkGroupConfiguration?

Type: boolean | IResolvable (optional)

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 Override client-side settings .

engineVersion?

Type: IResolvable | EngineVersionProperty (optional)

The engine version that all queries running on the workgroup use.

executionRole?

Type: string (optional)

Role used to access user resources in an Athena for Apache Spark session.

This property applies only to Spark-enabled workgroups in Athena.

publishCloudWatchMetricsEnabled?

Type: boolean | IResolvable (optional)

Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.

requesterPaysEnabled?

Type: boolean | IResolvable (optional)

If set to true , allows members assigned to a workgroup to reference 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 .

resultConfiguration?

Type: IResolvable | ResultConfigurationProperty (optional)

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

For more information, see Work with query results and recent queries .