class CfnWorkGroupPropsMixin

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

Implements IMixin

Extends Mixin

The AWS::Athena::WorkGroup resource specifies an Amazon Athena workgroup, which contains a name, description, creation time, state, and other configuration, listed under WorkGroupConfiguration .

Each workgroup enables you to isolate queries for you or your group from other queries in the same account. For more information, see CreateWorkGroup in the Amazon Athena API Reference .

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 } from '@aws-cdk/mixins-preview';
import { mixins as athena_mixins } from '@aws-cdk/mixins-preview/aws-athena';
const cfnWorkGroupPropsMixin = new athena_mixins.CfnWorkGroupPropsMixin({
  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,
    },
  },
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnWorkGroupPropsMixin(props: CfnWorkGroupMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnWorkGroupMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::Athena::WorkGroup.

Properties

Name	Type	Description
props	CfnWorkGroupMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnWorkGroupMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.