interface CfnWorkGroupMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Athena.Mixins.CfnWorkGroupMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsathena/mixins#CfnWorkGroupMixinProps
Java	software.amazon.awscdk.mixins.preview.services.athena.mixins.CfnWorkGroupMixinProps
Python	aws_cdk.mixins_preview.aws_athena.mixins.CfnWorkGroupMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_athena » mixins » CfnWorkGroupMixinProps

Properties for CfnWorkGroupPropsMixin.

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 { mixins as athena_mixins } from '@aws-cdk/mixins-preview/aws-athena';
const cfnWorkGroupMixinProps: athena_mixins.CfnWorkGroupMixinProps = {
  description: 'description',
  name: 'name',
  recursiveDeleteOption: false,
  state: 'state',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  workGroupConfiguration: {
    additionalConfiguration: 'additionalConfiguration',
    bytesScannedCutoffPerQuery: 123,
    customerContentEncryptionConfiguration: {
      kmsKey: 'kmsKey',
    },
    enforceWorkGroupConfiguration: false,
    engineConfiguration: {
      additionalConfigs: {
        additionalConfigsKey: 'additionalConfigs',
      },
      classifications: [{
        name: 'name',
        properties: {
          propertiesKey: 'properties',
        },
      }],
      coordinatorDpuSize: 123,
      defaultExecutorDpuSize: 123,
      maxConcurrentDpus: 123,
      sparkProperties: {
        sparkPropertiesKey: 'sparkProperties',
      },
    },
    engineVersion: {
      effectiveEngineVersion: 'effectiveEngineVersion',
      selectedEngineVersion: 'selectedEngineVersion',
    },
    executionRole: 'executionRole',
    managedQueryResultsConfiguration: {
      enabled: false,
      encryptionConfiguration: {
        kmsKey: 'kmsKey',
      },
    },
    monitoringConfiguration: {
      cloudWatchLoggingConfiguration: {
        enabled: false,
        logGroup: 'logGroup',
        logStreamNamePrefix: 'logStreamNamePrefix',
        logTypes: {
          logTypesKey: ['logTypes'],
        },
      },
      managedLoggingConfiguration: {
        enabled: false,
        kmsKey: 'kmsKey',
      },
      s3LoggingConfiguration: {
        enabled: false,
        kmsKey: 'kmsKey',
        logLocation: 'logLocation',
      },
    },
    publishCloudWatchMetricsEnabled: false,
    requesterPaysEnabled: false,
    resultConfiguration: {
      aclConfiguration: {
        s3AclOption: 's3AclOption',
      },
      encryptionConfiguration: {
        encryptionOption: 'encryptionOption',
        kmsKey: 'kmsKey',
      },
      expectedBucketOwner: 'expectedBucketOwner',
      outputLocation: 'outputLocation',
    },
  },
  workGroupConfigurationUpdates: {
    additionalConfiguration: 'additionalConfiguration',
    bytesScannedCutoffPerQuery: 123,
    customerContentEncryptionConfiguration: {
      kmsKey: 'kmsKey',
    },
    enforceWorkGroupConfiguration: false,
    engineConfiguration: {
      additionalConfigs: {
        additionalConfigsKey: 'additionalConfigs',
      },
      classifications: [{
        name: 'name',
        properties: {
          propertiesKey: 'properties',
        },
      }],
      coordinatorDpuSize: 123,
      defaultExecutorDpuSize: 123,
      maxConcurrentDpus: 123,
      sparkProperties: {
        sparkPropertiesKey: 'sparkProperties',
      },
    },
    engineVersion: {
      effectiveEngineVersion: 'effectiveEngineVersion',
      selectedEngineVersion: 'selectedEngineVersion',
    },
    executionRole: 'executionRole',
    managedQueryResultsConfiguration: {
      enabled: false,
      encryptionConfiguration: {
        kmsKey: 'kmsKey',
      },
    },
    monitoringConfiguration: {
      cloudWatchLoggingConfiguration: {
        enabled: false,
        logGroup: 'logGroup',
        logStreamNamePrefix: 'logStreamNamePrefix',
        logTypes: {
          logTypesKey: ['logTypes'],
        },
      },
      managedLoggingConfiguration: {
        enabled: false,
        kmsKey: 'kmsKey',
      },
      s3LoggingConfiguration: {
        enabled: false,
        kmsKey: 'kmsKey',
        logLocation: 'logLocation',
      },
    },
    publishCloudWatchMetricsEnabled: false,
    removeBytesScannedCutoffPerQuery: false,
    removeCustomerContentEncryptionConfiguration: false,
    requesterPaysEnabled: false,
    resultConfigurationUpdates: {
      aclConfiguration: {
        s3AclOption: 's3AclOption',
      },
      encryptionConfiguration: {
        encryptionOption: 'encryptionOption',
        kmsKey: 'kmsKey',
      },
      expectedBucketOwner: 'expectedBucketOwner',
      outputLocation: 'outputLocation',
      removeAclConfiguration: false,
      removeEncryptionConfiguration: false,
      removeExpectedBucketOwner: false,
      removeOutputLocation: false,
    },
  },
};

Properties

Name	Type	Description
description?	string	The workgroup description.
name?	string	The workgroup name.
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.
workGroupConfigurationUpdates?⚠️	IResolvable | 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.

---

description?

Type: string (optional)

The workgroup description.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-workgroup.html#cfn-athena-workgroup-description

---

name?

Type: string (optional)

The workgroup name.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-workgroup.html#cfn-athena-workgroup-name

---

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-workgroup.html#cfn-athena-workgroup-recursivedeleteoption

---

state?

Type: string (optional)

The state of the workgroup: ENABLED or DISABLED.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-workgroup.html#cfn-athena-workgroup-state

---

tags?

Type: CfnTag[] (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-workgroup.html#cfn-athena-workgroup-tags

---

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-workgroup.html#cfn-athena-workgroup-workgroupconfiguration

---

workGroupConfigurationUpdates?⚠️

⚠️ Deprecated: this property has been deprecated

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-workgroup.html#cfn-athena-workgroup-workgroupconfigurationupdates