Interface CfnWorkGroup.IResultConfigurationProperty
The location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query and calculation results.
Namespace: Amazon.CDK.AWS.Athena
Assembly: Amazon.CDK.AWS.Athena.dll
Syntax (csharp)
public interface IResultConfigurationProperty
Syntax (vb)
Public Interface IResultConfigurationProperty
Remarks
These are known as "client-side settings". If workgroup settings override client-side settings, then the query uses the workgroup settings.
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Athena;
var resultConfigurationProperty = new ResultConfigurationProperty {
AclConfiguration = new AclConfigurationProperty {
S3AclOption = "s3AclOption"
},
EncryptionConfiguration = new EncryptionConfigurationProperty {
EncryptionOption = "encryptionOption",
// the properties below are optional
KmsKey = "kmsKey"
},
ExpectedBucketOwner = "expectedBucketOwner",
OutputLocation = "outputLocation"
};
Synopsis
Properties
AclConfiguration | Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results. |
EncryptionConfiguration | If query results are encrypted in Amazon S3, indicates the encryption option used (for example, |
ExpectedBucketOwner | The account ID that you expect to be the owner of the Amazon S3 bucket specified by |
OutputLocation | The location in Amazon S3 where your query results are stored, such as |
Properties
AclConfiguration
Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results.
virtual object AclConfiguration { get; }
Property Value
System.Object
Remarks
Currently the only supported canned ACL is BUCKET_OWNER_FULL_CONTROL
. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ACL configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See EnforceWorkGroupConfiguration
.
EncryptionConfiguration
If query results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE_KMS
or CSE_KMS
) and key information.
virtual object EncryptionConfiguration { get; }
Property Value
System.Object
Remarks
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
and Workgroup Settings Override Client-Side Settings .
ExpectedBucketOwner
The account ID that you expect to be the owner of the Amazon S3 bucket specified by ResultConfiguration:OutputLocation
.
virtual string ExpectedBucketOwner { get; }
Property Value
System.String
Remarks
If set, Athena uses the value for ExpectedBucketOwner
when it makes Amazon S3 calls to your specified output location. If the ExpectedBucketOwner
account ID does not match the actual owner of the Amazon S3 bucket, the call fails with a permissions error.
This is a client-side setting. 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 EnforceWorkGroupConfiguration
.
OutputLocation
The location in Amazon S3 where your query results are stored, such as s3://path/to/query/bucket/
.
virtual string OutputLocation { get; }
Property Value
System.String
Remarks
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 and EnforceWorkGroupConfiguration
.