AWS::Athena::WorkGroup ResultConfigurationUpdates - AWS CloudFormation
SyntaxProperties

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 AWS CloudFormation template, use the following syntax:

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 AWS account ID that you expect to be the owner of the Amazon S3 bucket specified by ResultConfiguration$OutputLocation. If set, Athena uses the value for ExpectedBucketOwner when it makes Amazon S3 calls to your specified output location. If the ExpectedBucketOwner AWS 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 ExpectedBucketOwner setting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

Required: No

Type: String

Pattern: ^[0-9]+$

Minimum: 12

Maximum: 12

Update 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 to false or not set, and a value is present in the AclConfiguration of ResultConfigurationUpdates, the AclConfiguration in the workgroup's ResultConfiguration is 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 AWS account ID previously specified for ResultConfiguration$ExpectedBucketOwner. If set to "false" or not set, and a value is present in the ExpectedBucketOwner in ResultConfigurationUpdates (the client-side setting), the ExpectedBucketOwner in the workgroup's ResultConfiguration is 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