interface WorkGroupConfigurationUpdatesProperty
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.Athena.CfnWorkGroup.WorkGroupConfigurationUpdatesProperty |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsathena#CfnWorkGroup_WorkGroupConfigurationUpdatesProperty |
Java | software.amazon.awscdk.services.athena.CfnWorkGroup.WorkGroupConfigurationUpdatesProperty |
Python | aws_cdk.aws_athena.CfnWorkGroup.WorkGroupConfigurationUpdatesProperty |
TypeScript | aws-cdk-lib » aws_athena » CfnWorkGroup » WorkGroupConfigurationUpdatesProperty |
The configuration information that will be updated for this workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, whether the workgroup settings override the client-side settings, and the data usage limit for the amount of bytes scanned per query, if it is specified.
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 workGroupConfigurationUpdatesProperty: athena.CfnWorkGroup.WorkGroupConfigurationUpdatesProperty = {
additionalConfiguration: 'additionalConfiguration',
bytesScannedCutoffPerQuery: 123,
customerContentEncryptionConfiguration: {
kmsKey: 'kmsKey',
},
enforceWorkGroupConfiguration: false,
engineVersion: {
effectiveEngineVersion: 'effectiveEngineVersion',
selectedEngineVersion: 'selectedEngineVersion',
},
executionRole: 'executionRole',
publishCloudWatchMetricsEnabled: false,
removeBytesScannedCutoffPerQuery: false,
removeCustomerContentEncryptionConfiguration: false,
requesterPaysEnabled: false,
resultConfigurationUpdates: {
aclConfiguration: {
s3AclOption: 's3AclOption',
},
encryptionConfiguration: {
encryptionOption: 'encryptionOption',
// the properties below are optional
kmsKey: 'kmsKey',
},
expectedBucketOwner: 'expectedBucketOwner',
outputLocation: 'outputLocation',
removeAclConfiguration: false,
removeEncryptionConfiguration: false,
removeExpectedBucketOwner: false,
removeOutputLocation: false,
},
};
Properties
Name | Type | Description |
---|---|---|
additional | string | Additional Configuration that are passed to Athena Spark Calculations running in this workgroup. |
bytes | number | The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan. |
customer | IResolvable | Customer | Indicates the KMS key for encrypting notebook content. |
enforce | boolean | IResolvable | If set to "true", the settings for the workgroup override client-side settings. |
engine | IResolvable | Engine | The Athena engine version for running queries. |
execution | string | Execution Role ARN required to run Athena Spark Calculations. |
publish | boolean | IResolvable | Indicates that the Amazon CloudWatch metrics are enabled for the workgroup. |
remove | boolean | IResolvable | Indicates that the data usage control limit per query is removed. |
remove | boolean | IResolvable | |
requester | boolean | IResolvable | If set to true, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. |
result | IResolvable | Result | The result configuration information about the queries in this workgroup that will be updated. |
additionalConfiguration?
Type:
string
(optional)
Additional Configuration that are passed to Athena Spark Calculations running in this workgroup.
bytesScannedCutoffPerQuery?
Type:
number
(optional)
The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
customerContentEncryptionConfiguration?
Type:
IResolvable
|
Customer
(optional)
Indicates the KMS key for encrypting notebook content.
enforceWorkGroupConfiguration?
Type:
boolean |
IResolvable
(optional)
If set to "true", the settings for the workgroup override client-side settings.
If set to "false", client-side settings are used
engineVersion?
Type:
IResolvable
|
Engine
(optional)
The Athena engine version for running queries.
executionRole?
Type:
string
(optional)
Execution Role ARN required to run Athena Spark Calculations.
publishCloudWatchMetricsEnabled?
Type:
boolean |
IResolvable
(optional)
Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
removeBytesScannedCutoffPerQuery?
Type:
boolean |
IResolvable
(optional)
Indicates that the data usage control limit per query is removed.
removeCustomerContentEncryptionConfiguration?
Type:
boolean |
IResolvable
(optional)
requesterPaysEnabled?
Type:
boolean |
IResolvable
(optional)
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.
resultConfigurationUpdates?
Type:
IResolvable
|
Result
(optional)
The result configuration information about the queries in this workgroup that will be updated.
Includes the updated results location and an updated option for encrypting query results.