interface CfnWorkGroupProps

This page is available in another version. Click here for the v2 documentation.

Language	Type name
.NET	Amazon.CDK.AWS.Athena.CfnWorkGroupProps
Java	software.amazon.awscdk.services.athena.CfnWorkGroupProps
Python	aws_cdk.aws_athena.CfnWorkGroupProps
TypeScript	@aws-cdk/aws-athena » CfnWorkGroupProps

Properties for defining a CfnWorkGroup.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as athena from '@aws-cdk/aws-athena';
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',
    },
  },
};

Properties

Name	Type	Description
name	string	The workgroup name.
description?	string	The workgroup description.
recursiveDeleteOption?	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?	CfnTag[]	The tags (key-value pairs) to associate with this resource.
workGroupConfiguration?	IResolvable | WorkGroupConfigurationProperty	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.

---

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: CfnTag[] (optional)

The tags (key-value pairs) to associate with this resource.

---

workGroupConfiguration?

Type: IResolvable | WorkGroupConfigurationProperty (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.