AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Athena::WorkGroup

CfnWorkGroup

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](https://docs.aws.amazon.com/athena/latest/APIReference/API_CreateWorkGroup.html) in the *Amazon Athena API Reference* .

Import

import { CfnWorkGroup } from 'aws-cdk-lib/aws-athena';

Or use the module namespace:

import * as athena from 'aws-cdk-lib/aws-athena';
// athena.CfnWorkGroup

Properties

Configuration passed to the constructor as CfnWorkGroupProps.

nameRequired
string

The workgroup name.

descriptionOptional
string

The workgroup description.

recursiveDeleteOptionOptional
boolean | IResolvable

The option to delete a workgroup and its contents even if the workgroup contains any named queries. The default is false.

stateOptional
string

The state of the workgroup: ENABLED or DISABLED.

tagsOptional
CfnTag[]

The tags (key-value pairs) to associate with this resource.

workGroupConfigurationOptional
IResolvable | 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.

workGroupConfigurationUpdatesOptionalDeprecated
IResolvable | 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.

Deprecated: this property has been deprecated

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::Athena::WorkGroupView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-athena
CFN TypeAWS::Athena::WorkGroup
Properties7

Related Constructs

Explore This Service

External Links