class CfnFlywheelPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Comprehend.Mixins.CfnFlywheelPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awscomprehend/mixins#CfnFlywheelPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.comprehend.mixins.CfnFlywheelPropsMixin
Python	aws_cdk.mixins_preview.aws_comprehend.mixins.CfnFlywheelPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_comprehend » mixins » CfnFlywheelPropsMixin

Implements IMixin

Extends Mixin

A flywheel is an AWS resource that orchestrates the ongoing training of a model for custom classification or custom entity recognition.

You can create a flywheel to start with an existing trained model, or Comprehend can create and train a new model.

When you create the flywheel, Comprehend creates a data lake in your account. The data lake holds the training data and test data for all versions of the model.

To use a flywheel with an existing trained model, you specify the active model version. Comprehend copies the model's training data and test data into the flywheel's data lake.

To use the flywheel with a new model, you need to provide a dataset for training data (and optional test data) when you create the flywheel.

For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-flywheel.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 comprehend_mixins } from '@aws-cdk/mixins-preview/aws-comprehend';
const cfnFlywheelPropsMixin = new comprehend_mixins.CfnFlywheelPropsMixin({
  activeModelArn: 'activeModelArn',
  dataAccessRoleArn: 'dataAccessRoleArn',
  dataLakeS3Uri: 'dataLakeS3Uri',
  dataSecurityConfig: {
    dataLakeKmsKeyId: 'dataLakeKmsKeyId',
    modelKmsKeyId: 'modelKmsKeyId',
    volumeKmsKeyId: 'volumeKmsKeyId',
    vpcConfig: {
      securityGroupIds: ['securityGroupIds'],
      subnets: ['subnets'],
    },
  },
  flywheelName: 'flywheelName',
  modelType: 'modelType',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  taskConfig: {
    documentClassificationConfig: {
      labels: ['labels'],
      mode: 'mode',
    },
    entityRecognitionConfig: {
      entityTypes: [{
        type: 'type',
      }],
    },
    languageCode: 'languageCode',
  },
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnFlywheelPropsMixin(props: CfnFlywheelMixinProps, options?: CfnPropertyMixinOptions)

Parameters

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

Create a mixin to apply properties to AWS::Comprehend::Flywheel.

Properties

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

---

props

Type: CfnFlywheelMixinProps

---

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.