Skip to content
This repository was archived by the owner on Dec 7, 2023. It is now read-only.

Commit bdfd4bc

Browse files
taammanntaammann
committed
Athena WorkGroup resource added
1 parent 6d98e96 commit bdfd4bc

9 files changed

+559
-1
lines changed

‎doc_source/AWS_Athena.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Amazon Athena Resource Type Reference<a name="AWS_Athena"></a>
22

33
**Resource Types**
4-
+ [AWS::Athena::NamedQuery](aws-resource-athena-namedquery.md)
4+
+ [AWS::Athena::NamedQuery](aws-resource-athena-namedquery.md)
5+
+ [AWS::Athena::WorkGroup](aws-resource-athena-workgroup.md)

‎doc_source/aws-properties-athena-workgroup-encryptionconfiguration.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# AWS::Athena::WorkGroup EncryptionConfiguration<a name="aws-properties-athena-workgroup-encryptionconfiguration"></a>
2+
3+
If query results are encrypted in Amazon S3, indicates the encryption option used \(for example, `SSE-KMS` or `CSE-KMS`\) and key information\.
4+
5+
## Syntax<a name="aws-properties-athena-workgroup-encryptionconfiguration-syntax"></a>
6+
7+
To declare this entity in your AWS CloudFormation template, use the following syntax:
8+
9+
### JSON<a name="aws-properties-athena-workgroup-encryptionconfiguration-syntax.json"></a>
10+
11+
```
12+
{
13+
"[EncryptionOption](#cfn-athena-workgroup-encryptionconfiguration-encryptionoption)" : String,
14+
"[KmsKey](#cfn-athena-workgroup-encryptionconfiguration-kmskey)" : String
15+
}
16+
```
17+
18+
### YAML<a name="aws-properties-athena-workgroup-encryptionconfiguration-syntax.yaml"></a>
19+
20+
```
21+
[EncryptionOption](#cfn-athena-workgroup-encryptionconfiguration-encryptionoption): String
22+
[KmsKey](#cfn-athena-workgroup-encryptionconfiguration-kmskey): String
23+
```
24+
25+
## Properties<a name="aws-properties-athena-workgroup-encryptionconfiguration-properties"></a>
26+
27+
`EncryptionOption` <a name="cfn-athena-workgroup-encryptionconfiguration-encryptionoption"></a>
28+
Indicates whether Amazon S3 server\-side encryption with Amazon S3\-managed keys \(`SSE-S3`\), server\-side encryption with KMS\-managed keys \(`SSE-KMS`\), or client\-side encryption with KMS\-managed keys \(CSE\-KMS\) is used\.
29+
If a query runs in a workgroup and the workgroup overrides client\-side settings, then the workgroup's setting for encryption is used\. It specifies whether query results must be encrypted, for all queries that run in this workgroup\.
30+
*Required*: Yes
31+
*Type*: String
32+
*Allowed Values*: `CSE_KMS | SSE_KMS | SSE_S3`
33+
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
34+
35+
`KmsKey` <a name="cfn-athena-workgroup-encryptionconfiguration-kmskey"></a>
36+
For `SSE-KMS` and `CSE-KMS`, this is the KMS key ARN or ID\.
37+
*Required*: No
38+
*Type*: String
39+
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

‎doc_source/aws-properties-athena-workgroup-resultconfiguration.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# AWS::Athena::WorkGroup ResultConfiguration<a name="aws-properties-athena-workgroup-resultconfiguration"></a>
2+
3+
The location in Amazon S3 where query results are stored and the encryption option, if any, used for query results\. These are known as "client\-side settings"\. If workgroup settings override client\-side settings, then the query uses the workgroup settings\.
4+
5+
## Syntax<a name="aws-properties-athena-workgroup-resultconfiguration-syntax"></a>
6+
7+
To declare this entity in your AWS CloudFormation template, use the following syntax:
8+
9+
### JSON<a name="aws-properties-athena-workgroup-resultconfiguration-syntax.json"></a>
10+
11+
```
12+
{
13+
"[EncryptionConfiguration](#cfn-athena-workgroup-resultconfiguration-encryptionconfiguration)" : [EncryptionConfiguration](aws-properties-athena-workgroup-encryptionconfiguration.md),
14+
"[OutputLocation](#cfn-athena-workgroup-resultconfiguration-outputlocation)" : String
15+
}
16+
```
17+
18+
### YAML<a name="aws-properties-athena-workgroup-resultconfiguration-syntax.yaml"></a>
19+
20+
```
21+
[EncryptionConfiguration](#cfn-athena-workgroup-resultconfiguration-encryptionconfiguration):
22+
[EncryptionConfiguration](aws-properties-athena-workgroup-encryptionconfiguration.md)
23+
[OutputLocation](#cfn-athena-workgroup-resultconfiguration-outputlocation): String
24+
```
25+
26+
## Properties<a name="aws-properties-athena-workgroup-resultconfiguration-properties"></a>
27+
28+
`EncryptionConfiguration` <a name="cfn-athena-workgroup-resultconfiguration-encryptionconfiguration"></a>
29+
If query results are encrypted in Amazon S3, indicates the encryption option used \(for example, `SSE-KMS` or `CSE-KMS`\) and key information\. This is a client\-side setting\. If workgroup settings override client\-side settings, then the query uses the encryption configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup\. See [EnforceWorkGroupConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfigurationupdates.html#cfn-athena-workgroup-workgroupconfigurationupdates-enforceworkgroupconfiguration) and [Workgroup Settings Override Client\-Side Settings](https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html)\.
30+
*Required*: No
31+
*Type*: [EncryptionConfiguration](aws-properties-athena-workgroup-encryptionconfiguration.md)
32+
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
33+
34+
`OutputLocation` <a name="cfn-athena-workgroup-resultconfiguration-outputlocation"></a>
35+
The location in Amazon S3 where your query results are stored, such as `s3://path/to/query/bucket/`\. To run a query, you must specify the query results location using either a client\-side setting for individual queries or a location specified by the workgroup\. If workgroup settings override client\-side settings, then the query uses the location specified for the workgroup\. If no query location is set, Athena issues an error\. For more information, see [Working with Query Results, Output Files, and Query History](https://docs.aws.amazon.com/athena/latest/ug/querying.html) and [EnforceWorkGroupConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfigurationupdates.html#cfn-athena-workgroup-workgroupconfigurationupdates-enforceworkgroupconfiguration)\.
36+
*Required*: No
37+
*Type*: String
38+
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

‎doc_source/aws-properties-athena-workgroup-resultconfigurationupdates.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# AWS::Athena::WorkGroup ResultConfigurationUpdates<a name="aws-properties-athena-workgroup-resultconfigurationupdates"></a>
2+
3+
The information about the updates in the query results, such as output location and encryption configuration for the query results\.
4+
5+
## Syntax<a name="aws-properties-athena-workgroup-resultconfigurationupdates-syntax"></a>
6+
7+
To declare this entity in your AWS CloudFormation template, use the following syntax:
8+
9+
### JSON<a name="aws-properties-athena-workgroup-resultconfigurationupdates-syntax.json"></a>
10+
11+
```
12+
{
13+
"[EncryptionConfiguration](#cfn-athena-workgroup-resultconfigurationupdates-encryptionconfiguration)" : [EncryptionConfiguration](aws-properties-athena-workgroup-encryptionconfiguration.md),
14+
"[OutputLocation](#cfn-athena-workgroup-resultconfigurationupdates-outputlocation)" : String,
15+
"[RemoveEncryptionConfiguration](#cfn-athena-workgroup-resultconfigurationupdates-removeencryptionconfiguration)" : Boolean,
16+
"[RemoveOutputLocation](#cfn-athena-workgroup-resultconfigurationupdates-removeoutputlocation)" : Boolean
17+
}
18+
```
19+
20+
### YAML<a name="aws-properties-athena-workgroup-resultconfigurationupdates-syntax.yaml"></a>
21+
22+
```
23+
[EncryptionConfiguration](#cfn-athena-workgroup-resultconfigurationupdates-encryptionconfiguration):
24+
[EncryptionConfiguration](aws-properties-athena-workgroup-encryptionconfiguration.md)
25+
[OutputLocation](#cfn-athena-workgroup-resultconfigurationupdates-outputlocation): String
26+
[RemoveEncryptionConfiguration](#cfn-athena-workgroup-resultconfigurationupdates-removeencryptionconfiguration): Boolean
27+
[RemoveOutputLocation](#cfn-athena-workgroup-resultconfigurationupdates-removeoutputlocation): Boolean
28+
```
29+
30+
## Properties<a name="aws-properties-athena-workgroup-resultconfigurationupdates-properties"></a>
31+
32+
`EncryptionConfiguration` <a name="cfn-athena-workgroup-resultconfigurationupdates-encryptionconfiguration"></a>
33+
The encryption configuration for the query results\.
34+
*Required*: No
35+
*Type*: [EncryptionConfiguration](aws-properties-athena-workgroup-encryptionconfiguration.md)
36+
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
37+
38+
`OutputLocation` <a name="cfn-athena-workgroup-resultconfigurationupdates-outputlocation"></a>
39+
The location in Amazon S3 where your query results are stored, such as `s3://path/to/query/bucket/`\. For more information, see [Query Results](https://docs.aws.amazon.com/athena/latest/ug/querying.html) If workgroup settings override client\-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup\. The "workgroup settings override" is specified in EnforceWorkGroupConfiguration \(true/false\) in the WorkGroupConfiguration\. See [EnforceWorkGroupConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfigurationupdates.html#cfn-athena-workgroup-workgroupconfigurationupdates-enforceworkgroupconfiguration)\.
40+
*Required*: No
41+
*Type*: String
42+
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
43+
44+
`RemoveEncryptionConfiguration` <a name="cfn-athena-workgroup-resultconfigurationupdates-removeencryptionconfiguration"></a>
45+
If set to "true", indicates that the previously\-specified encryption configuration \(also known as the client\-side setting\) for queries in this workgroup should be ignored and set to null\. If set to "false" or not set, and a value is present in the EncryptionConfiguration in ResultConfigurationUpdates \(the client\-side setting\), the EncryptionConfiguration in the workgroup's ResultConfiguration will be updated with the new value\. For more information, see [Workgroup Settings Override Client\-Side Settings](https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html)\.
46+
*Required*: No
47+
*Type*: Boolean
48+
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
49+
50+
`RemoveOutputLocation` <a name="cfn-athena-workgroup-resultconfigurationupdates-removeoutputlocation"></a>
51+
If set to "true", indicates that the previously\-specified query results location \(also known as a client\-side setting\) for queries in this workgroup should be ignored and set to null\. If set to "false" or not set, and a value is present in the OutputLocation in ResultConfigurationUpdates \(the client\-side setting\), the OutputLocation in the workgroup's ResultConfiguration will be updated with the new value\. For more information, see [Workgroup Settings Override Client\-Side Settings](https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html)\.
52+
*Required*: No
53+
*Type*: Boolean
54+
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

‎doc_source/aws-properties-athena-workgroup-tags.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# AWS::Athena::WorkGroup Tags<a name="aws-properties-athena-workgroup-tags"></a>
2+
3+
An array of key\-value pairs to apply to this resource\.
4+
5+
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\.
6+
7+
## Syntax<a name="aws-properties-athena-workgroup-tags-syntax"></a>
8+
9+
To declare this entity in your AWS CloudFormation template, use the following syntax:
10+
11+
### JSON<a name="aws-properties-athena-workgroup-tags-syntax.json"></a>
12+
13+
```
14+
{
15+
"[Tags](#cfn-athena-workgroup-tags-tags)" : [ [Tag](#aws-properties-athena-workgroup-tags), ... ]
16+
}
17+
```
18+
19+
### YAML<a name="aws-properties-athena-workgroup-tags-syntax.yaml"></a>
20+
21+
```
22+
[Tags](#cfn-athena-workgroup-tags-tags):
23+
- [Tag](#aws-properties-athena-workgroup-tags)
24+
```
25+
26+
## Properties<a name="aws-properties-athena-workgroup-tags-properties"></a>
27+
28+
`Tags` <a name="cfn-athena-workgroup-tags-tags"></a>
29+
A array of key\-value pairs to apply to this resource\.
30+
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\.
31+
*Required*: No
32+
*Type*: [List](#aws-properties-athena-workgroup-tags) of [Tag](#aws-properties-athena-workgroup-tags)
33+
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

‎doc_source/aws-properties-athena-workgroup-workgroupconfiguration.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# AWS::Athena::WorkGroup WorkGroupConfiguration<a name="aws-properties-athena-workgroup-workgroupconfiguration"></a>
2+
3+
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\.
4+
5+
## Syntax<a name="aws-properties-athena-workgroup-workgroupconfiguration-syntax"></a>
6+
7+
To declare this entity in your AWS CloudFormation template, use the following syntax:
8+
9+
### JSON<a name="aws-properties-athena-workgroup-workgroupconfiguration-syntax.json"></a>
10+
11+
```
12+
{
13+
"[BytesScannedCutoffPerQuery](#cfn-athena-workgroup-workgroupconfiguration-bytesscannedcutoffperquery)" : Integer,
14+
"[EnforceWorkGroupConfiguration](#cfn-athena-workgroup-workgroupconfiguration-enforceworkgroupconfiguration)" : Boolean,
15+
"[PublishCloudWatchMetricsEnabled](#cfn-athena-workgroup-workgroupconfiguration-publishcloudwatchmetricsenabled)" : Boolean,
16+
"[RequesterPaysEnabled](#cfn-athena-workgroup-workgroupconfiguration-requesterpaysenabled)" : Boolean,
17+
"[ResultConfiguration](#cfn-athena-workgroup-workgroupconfiguration-resultconfiguration)" : [ResultConfiguration](aws-properties-athena-workgroup-resultconfiguration.md)
18+
}
19+
```
20+
21+
### YAML<a name="aws-properties-athena-workgroup-workgroupconfiguration-syntax.yaml"></a>
22+
23+
```
24+
[BytesScannedCutoffPerQuery](#cfn-athena-workgroup-workgroupconfiguration-bytesscannedcutoffperquery): Integer
25+
[EnforceWorkGroupConfiguration](#cfn-athena-workgroup-workgroupconfiguration-enforceworkgroupconfiguration): Boolean
26+
[PublishCloudWatchMetricsEnabled](#cfn-athena-workgroup-workgroupconfiguration-publishcloudwatchmetricsenabled): Boolean
27+
[RequesterPaysEnabled](#cfn-athena-workgroup-workgroupconfiguration-requesterpaysenabled): Boolean
28+
[ResultConfiguration](#cfn-athena-workgroup-workgroupconfiguration-resultconfiguration):
29+
[ResultConfiguration](aws-properties-athena-workgroup-resultconfiguration.md)
30+
```
31+
32+
## Properties<a name="aws-properties-athena-workgroup-workgroupconfiguration-properties"></a>
33+
34+
`BytesScannedCutoffPerQuery` <a name="cfn-athena-workgroup-workgroupconfiguration-bytesscannedcutoffperquery"></a>
35+
The upper data usage limit \(cutoff\) for the amount of bytes a single query in a workgroup is allowed to scan\.
36+
*Required*: No
37+
*Type*: Integer
38+
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
39+
40+
`EnforceWorkGroupConfiguration` <a name="cfn-athena-workgroup-workgroupconfiguration-enforceworkgroupconfiguration"></a>
41+
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](https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html)\.
42+
*Required*: No
43+
*Type*: Boolean
44+
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
45+
46+
`PublishCloudWatchMetricsEnabled` <a name="cfn-athena-workgroup-workgroupconfiguration-publishcloudwatchmetricsenabled"></a>
47+
Indicates that the Amazon CloudWatch metrics are enabled for the workgroup\.
48+
*Required*: No
49+
*Type*: Boolean
50+
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
51+
52+
`RequesterPaysEnabled` <a name="cfn-athena-workgroup-workgroupconfiguration-requesterpaysenabled"></a>
53+
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*\.
54+
*Required*: No
55+
*Type*: Boolean
56+
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
57+
58+
`ResultConfiguration` <a name="cfn-athena-workgroup-workgroupconfiguration-resultconfiguration"></a>
59+
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](https://docs.aws.amazon.com/athena/latest/ug/querying.html)\.
60+
*Required*: No
61+
*Type*: [ResultConfiguration](aws-properties-athena-workgroup-resultconfiguration.md)
62+
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

0 commit comments

Comments
 (0)