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 option determines whether workgroup settings override client-side query settings.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "AdditionalConfiguration" :String, "BytesScannedCutoffPerQuery" :Integer, "CustomerContentEncryptionConfiguration" :CustomerContentEncryptionConfiguration, "EnforceWorkGroupConfiguration" :Boolean, "EngineVersion" :EngineVersion, "ExecutionRole" :String, "PublishCloudWatchMetricsEnabled" :Boolean, "RequesterPaysEnabled" :Boolean, "ResultConfiguration" :ResultConfiguration}
YAML
AdditionalConfiguration:StringBytesScannedCutoffPerQuery:IntegerCustomerContentEncryptionConfiguration:CustomerContentEncryptionConfigurationEnforceWorkGroupConfiguration:BooleanEngineVersion:EngineVersionExecutionRole:StringPublishCloudWatchMetricsEnabled:BooleanRequesterPaysEnabled:BooleanResultConfiguration:ResultConfiguration
Properties
AdditionalConfiguration-
Specifies a user defined JSON string that is passed to the session engine.
Required: No
Type: String
Minimum:
1Maximum:
128Update requires: No interruption
BytesScannedCutoffPerQuery-
The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan. No default is defined.
Note
This property currently supports integer types. Support for long values is planned.
Required: No
Type: Integer
Minimum:
10000000Update requires: No interruption
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
Update requires: No interruption
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 Workgroup Settings Override Client-Side Settings.
Required: No
Type: Boolean
Update requires: No interruption
EngineVersion-
The engine version that all queries running on the workgroup use.
Required: No
Type: EngineVersion
Update requires: No interruption
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:
20Maximum:
2048Update requires: No interruption
PublishCloudWatchMetricsEnabled-
Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
Required: No
Type: Boolean
Update requires: No interruption
RequesterPaysEnabled-
If set to
true, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set tofalse, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default isfalse. For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide.Required: No
Type: Boolean
Update requires: No interruption
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 Working with Query Results, Output Files, and Query History.
Required: No
Type: ResultConfiguration
Update requires: No interruption