This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.
AWS::Athena::WorkGroup ResultConfigurationUpdates
The information about the updates in the query results, such as output location and encryption configuration for the query results.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "AclConfiguration" :AclConfiguration, "EncryptionConfiguration" :EncryptionConfiguration, "ExpectedBucketOwner" :String, "OutputLocation" :String, "RemoveAclConfiguration" :Boolean, "RemoveEncryptionConfiguration" :Boolean, "RemoveExpectedBucketOwner" :Boolean, "RemoveOutputLocation" :Boolean}
YAML
AclConfiguration:AclConfigurationEncryptionConfiguration:EncryptionConfigurationExpectedBucketOwner:StringOutputLocation:StringRemoveAclConfiguration:BooleanRemoveEncryptionConfiguration:BooleanRemoveExpectedBucketOwner:BooleanRemoveOutputLocation:Boolean
Properties
AclConfiguration-
The ACL configuration for the query results.
Required: No
Type: AclConfiguration
Update requires: No interruption
EncryptionConfiguration-
The encryption configuration for the query results.
Required: No
Type: EncryptionConfiguration
Update requires: No interruption
ExpectedBucketOwner-
The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by https://docs.amazonaws.cn/AWSCloudFormation/latest/TemplateReference/aws-properties-athena-workgroup-resultconfiguration.html#cfn-athena-workgroup-resultconfiguration-outputlocation. If set, Athena uses the value for
ExpectedBucketOwnerwhen it makes Amazon S3 calls to your specified output location. If theExpectedBucketOwnerAmazon Web Services account ID does not match the actual owner of the Amazon S3 bucket, the call fails with a permissions error.If workgroup settings override client-side settings, then the query uses the
ExpectedBucketOwnersetting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See https://docs.amazonaws.cn/AWSCloudFormation/latest/TemplateReference/aws-properties-athena-workgroup-workgroupconfiguration.html#cfn-athena-workgroup-workgroupconfiguration-enforceworkgroupconfiguration and Workgroup Settings Override Client-Side Settings.Required: No
Type: String
Pattern:
^[0-9]+$Minimum:
12Maximum:
12Update requires: No interruption
OutputLocation-
The location in Amazon S3 where your query results are stored, such as
s3://path/to/query/bucket/. For more information, see Query Results 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.Required: No
Type: String
Update requires: No interruption
RemoveAclConfiguration-
If set to
true, indicates that the previously-specified ACL configuration for queries in this workgroup should be ignored and set to null. If set tofalseor not set, and a value is present in theAclConfigurationofResultConfigurationUpdates, theAclConfigurationin the workgroup'sResultConfigurationis updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings.Required: No
Type: Boolean
Update requires: No interruption
RemoveEncryptionConfiguration-
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 Override Client-Side Settings.
Required: No
Type: Boolean
Update requires: No interruption
RemoveExpectedBucketOwner-
If set to "true", removes the Amazon Web Services account ID previously specified for https://docs.amazonaws.cn/AWSCloudFormation/latest/TemplateReference/aws-properties-athena-workgroup-resultconfiguration.html#cfn-athena-workgroup-resultconfiguration-expectedbucketowner. If set to "false" or not set, and a value is present in the
ExpectedBucketOwnerinResultConfigurationUpdates(the client-side setting), theExpectedBucketOwnerin the workgroup'sResultConfigurationis updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings.Required: No
Type: Boolean
Update requires: No interruption
RemoveOutputLocation-
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 Override Client-Side Settings.
Required: No
Type: Boolean
Update requires: No interruption