interface CfnWorkGroupProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Athena.CfnWorkGroupProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsathena#CfnWorkGroupProps |
![]() | software.amazon.awscdk.services.athena.CfnWorkGroupProps |
![]() | aws_cdk.aws_athena.CfnWorkGroupProps |
![]() | aws-cdk-lib » aws_athena » CfnWorkGroupProps |
Properties for defining a CfnWorkGroup
.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-workgroup.html
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 cfnWorkGroupProps: athena.CfnWorkGroupProps = {
name: 'name',
// the properties below are optional
description: 'description',
recursiveDeleteOption: false,
state: 'state',
tags: [{
key: 'key',
value: 'value',
}],
workGroupConfiguration: {
additionalConfiguration: 'additionalConfiguration',
bytesScannedCutoffPerQuery: 123,
customerContentEncryptionConfiguration: {
kmsKey: 'kmsKey',
},
enforceWorkGroupConfiguration: false,
engineVersion: {
effectiveEngineVersion: 'effectiveEngineVersion',
selectedEngineVersion: 'selectedEngineVersion',
},
executionRole: 'executionRole',
publishCloudWatchMetricsEnabled: false,
requesterPaysEnabled: false,
resultConfiguration: {
aclConfiguration: {
s3AclOption: 's3AclOption',
},
encryptionConfiguration: {
encryptionOption: 'encryptionOption',
// the properties below are optional
kmsKey: 'kmsKey',
},
expectedBucketOwner: 'expectedBucketOwner',
outputLocation: 'outputLocation',
},
},
workGroupConfigurationUpdates: {
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 |
---|---|---|
name | string | The workgroup name. |
description? | string | The workgroup description. |
recursive | boolean | IResolvable | The option to delete a workgroup and its contents even if the workgroup contains any named queries. |
state? | string | The state of the workgroup: ENABLED or DISABLED. |
tags? | Cfn [] | The tags (key-value pairs) to associate with this resource. |
work | IResolvable | Work | The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether Amazon CloudWatch Metrics are enabled for the workgroup, and the limit for the amount of bytes scanned (cutoff) per query, if it is specified. |
work | IResolvable | Work | 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. |
name
Type:
string
The workgroup name.
description?
Type:
string
(optional)
The workgroup description.
recursiveDeleteOption?
Type:
boolean |
IResolvable
(optional)
The option to delete a workgroup and its contents even if the workgroup contains any named queries.
The default is false.
state?
Type:
string
(optional)
The state of the workgroup: ENABLED or DISABLED.
tags?
Type:
Cfn
[]
(optional)
The tags (key-value pairs) to associate with this resource.
workGroupConfiguration?
Type:
IResolvable
|
Work
(optional)
The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether Amazon CloudWatch Metrics are enabled for the workgroup, and the limit for the amount of bytes scanned (cutoff) per query, if it is specified.
The EnforceWorkGroupConfiguration
option determines whether workgroup settings override client-side query settings.
workGroupConfigurationUpdates?
⚠️ Deprecated: this property has been deprecated
Type:
IResolvable
|
Work
(optional)
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.