This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html). # AWS::Athena::WorkGroup WorkGroupConfiguration 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfiguration.html#cfn-athena-workgroup-workgroupconfiguration-enforceworkgroupconfiguration) option determines whether workgroup settings override client-side query settings. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AdditionalConfiguration](#cfn-athena-workgroup-workgroupconfiguration-additionalconfiguration)" : String, "[BytesScannedCutoffPerQuery](#cfn-athena-workgroup-workgroupconfiguration-bytesscannedcutoffperquery)" : Integer, "[CustomerContentEncryptionConfiguration](#cfn-athena-workgroup-workgroupconfiguration-customercontentencryptionconfiguration)" : CustomerContentEncryptionConfiguration, "[EnforceWorkGroupConfiguration](#cfn-athena-workgroup-workgroupconfiguration-enforceworkgroupconfiguration)" : Boolean, "[EngineConfiguration](#cfn-athena-workgroup-workgroupconfiguration-engineconfiguration)" : EngineConfiguration, "[EngineVersion](#cfn-athena-workgroup-workgroupconfiguration-engineversion)" : EngineVersion, "[ExecutionRole](#cfn-athena-workgroup-workgroupconfiguration-executionrole)" : String, "[ManagedQueryResultsConfiguration](#cfn-athena-workgroup-workgroupconfiguration-managedqueryresultsconfiguration)" : ManagedQueryResultsConfiguration, "[MonitoringConfiguration](#cfn-athena-workgroup-workgroupconfiguration-monitoringconfiguration)" : MonitoringConfiguration, "[PublishCloudWatchMetricsEnabled](#cfn-athena-workgroup-workgroupconfiguration-publishcloudwatchmetricsenabled)" : Boolean, "[RequesterPaysEnabled](#cfn-athena-workgroup-workgroupconfiguration-requesterpaysenabled)" : Boolean, "[ResultConfiguration](#cfn-athena-workgroup-workgroupconfiguration-resultconfiguration)" : ResultConfiguration } ``` ### YAML ``` [AdditionalConfiguration](#cfn-athena-workgroup-workgroupconfiguration-additionalconfiguration): String [BytesScannedCutoffPerQuery](#cfn-athena-workgroup-workgroupconfiguration-bytesscannedcutoffperquery): Integer [CustomerContentEncryptionConfiguration](#cfn-athena-workgroup-workgroupconfiguration-customercontentencryptionconfiguration): CustomerContentEncryptionConfiguration [EnforceWorkGroupConfiguration](#cfn-athena-workgroup-workgroupconfiguration-enforceworkgroupconfiguration): Boolean [EngineConfiguration](#cfn-athena-workgroup-workgroupconfiguration-engineconfiguration): EngineConfiguration [EngineVersion](#cfn-athena-workgroup-workgroupconfiguration-engineversion): EngineVersion [ExecutionRole](#cfn-athena-workgroup-workgroupconfiguration-executionrole): String [ManagedQueryResultsConfiguration](#cfn-athena-workgroup-workgroupconfiguration-managedqueryresultsconfiguration): ManagedQueryResultsConfiguration [MonitoringConfiguration](#cfn-athena-workgroup-workgroupconfiguration-monitoringconfiguration): MonitoringConfiguration [PublishCloudWatchMetricsEnabled](#cfn-athena-workgroup-workgroupconfiguration-publishcloudwatchmetricsenabled): Boolean [RequesterPaysEnabled](#cfn-athena-workgroup-workgroupconfiguration-requesterpaysenabled): Boolean [ResultConfiguration](#cfn-athena-workgroup-workgroupconfiguration-resultconfiguration): ResultConfiguration ``` ## Properties `AdditionalConfiguration` Specifies a user defined JSON string that is passed to the session engine. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `BytesScannedCutoffPerQuery` 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. *Required*: No *Type*: Integer *Minimum*: `10000000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CustomerContentEncryptionConfiguration` 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. *Required*: No *Type*: [CustomerContentEncryptionConfiguration](aws-properties-athena-workgroup-customercontentencryptionconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `EnforceWorkGroupConfiguration` 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](https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html). *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `EngineConfiguration` Property description not available. *Required*: No *Type*: [EngineConfiguration](aws-properties-athena-workgroup-engineconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `EngineVersion` The engine version that all queries running on the workgroup use. *Required*: No *Type*: [EngineVersion](aws-properties-athena-workgroup-engineversion.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ExecutionRole` Role used to access user resources in an Athena for Apache Spark session. This property applies only to Spark-enabled workgroups in Athena. *Required*: No *Type*: String *Pattern*: `^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$` *Minimum*: `20` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ManagedQueryResultsConfiguration` The configuration for storing results in Athena owned storage, which includes whether this feature is enabled; whether encryption configuration, if any, is used for encrypting query results. *Required*: No *Type*: [ManagedQueryResultsConfiguration](aws-properties-athena-workgroup-managedqueryresultsconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `MonitoringConfiguration` Contains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc. *Required*: No *Type*: [MonitoringConfiguration](aws-properties-athena-workgroup-monitoringconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PublishCloudWatchMetricsEnabled` Indicates that the Amazon CloudWatch metrics are enabled for the workgroup. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RequesterPaysEnabled` 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html) in the *Amazon Simple Storage Service Developer Guide*. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ResultConfiguration` 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](https://docs.aws.amazon.com/athena/latest/ug/querying.html). *Required*: No *Type*: [ResultConfiguration](aws-properties-athena-workgroup-resultconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)