interface ResultConfigurationProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Athena.CfnWorkGroup.ResultConfigurationProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsathena#CfnWorkGroup_ResultConfigurationProperty`
Java	`software.amazon.awscdk.services.athena.CfnWorkGroup.ResultConfigurationProperty`
Python	`aws_cdk.aws_athena.CfnWorkGroup.ResultConfigurationProperty`
TypeScript	`aws-cdk-lib` » `aws_athena` » `CfnWorkGroup` » `ResultConfigurationProperty`

The location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query and calculation results.

These are known as "client-side settings". If workgroup settings override client-side settings, then the query uses the workgroup settings.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_athena as athena } from 'aws-cdk-lib';
const resultConfigurationProperty: athena.CfnWorkGroup.ResultConfigurationProperty = {
  aclConfiguration: {
    s3AclOption: 's3AclOption',
  },
  encryptionConfiguration: {
    encryptionOption: 'encryptionOption',

    // the properties below are optional
    kmsKey: 'kmsKey',
  },
  expectedBucketOwner: 'expectedBucketOwner',
  outputLocation: 'outputLocation',
};

Properties

Name	Type	Description
aclConfiguration?	`IResolvable` `\|` `AclConfigurationProperty`	Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results.
encryptionConfiguration?	`IResolvable` `\|` `EncryptionConfigurationProperty`	If query results are encrypted in Amazon S3, indicates the encryption option used (for example, `SSE_KMS` or `CSE_KMS` ) and key information.
expectedBucketOwner?	`string`	The account ID that you expect to be the owner of the Amazon S3 bucket specified by `ResultConfiguration:OutputLocation` .
outputLocation?	`string`	The location in Amazon S3 where your query results are stored, such as `s3://path/to/query/bucket/` .

aclConfiguration?

Type: IResolvable | AclConfigurationProperty (optional)

Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results.

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?

Type: IResolvable | EncryptionConfigurationProperty (optional)

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 and Override client-side settings .

expectedBucketOwner?

Type: string (optional)

The 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 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?

Type: string (optional)

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 Work with query results and recent queries and EnforceWorkGroupConfiguration .