# CfnFlywheelProps

Properties for defining a `CfnFlywheel`.

Extends: CfnFlywheelProps
Used as props by: CfnFlywheel

- Source: Generated code
- Type last changed: v2.70.0 · 22 Mar 2023

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_comprehend as comprehend } from 'aws-cdk-lib';
const cfnFlywheelProps: comprehend.CfnFlywheelProps = {
  dataAccessRoleArn: 'dataAccessRoleArn',
  dataLakeS3Uri: 'dataLakeS3Uri',
  flywheelName: 'flywheelName',

  // the properties below are optional
  activeModelArn: 'activeModelArn',
  dataSecurityConfig: {
    dataLakeKmsKeyId: 'dataLakeKmsKeyId',
    modelKmsKeyId: 'modelKmsKeyId',
    volumeKmsKeyId: 'volumeKmsKeyId',
    vpcConfig: {
      securityGroupIds: ['securityGroupIds'],
      subnets: ['subnets'],
    },
  },
  modelType: 'modelType',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  taskConfig: {
    languageCode: 'languageCode',

    // the properties below are optional
    documentClassificationConfig: {
      mode: 'mode',

      // the properties below are optional
      labels: ['labels'],
    },
    entityRecognitionConfig: {
      entityTypes: [{
        type: 'type',
      }],
    },
  },
};
```

## Properties

- `activeModelArn`: string — The Amazon Resource Number (ARN) of the active model version.

- `dataAccessRoleArn`: string (required) — The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to access the flywheel data.

- `dataLakeS3Uri`: string (required) — Amazon S3 URI of the data lake location.

- `dataSecurityConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnFlywheel.DataSecurityConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_comprehend.CfnFlywheel.DataSecurityConfigProperty.html) — Data security configuration.

- `flywheelName`: string (required) — Name for the flywheel.

- `modelType`: string — Model type of the flywheel's model.

- `tags`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — Tags associated with the endpoint being created.

  A tag is a key-value pair that adds metadata to the endpoint. For example, a tag with "Sales" as the key might be added to an endpoint to indicate its use by the sales department.

- `taskConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnFlywheel.TaskConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_comprehend.CfnFlywheel.TaskConfigProperty.html) — Configuration about the model associated with a flywheel.