AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Comprehend::Flywheel

CfnFlywheel

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](https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) in the *Amazon Comprehend Developer Guide* .

Import

import { CfnFlywheel } from 'aws-cdk-lib/aws-comprehend';

Or use the module namespace:

import * as comprehend from 'aws-cdk-lib/aws-comprehend';
// comprehend.CfnFlywheel

Properties

Configuration passed to the constructor as CfnFlywheelProps.

dataAccessRoleArnRequired
string

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to access the flywheel data.

dataLakeS3UriRequired
string

Amazon S3 URI of the data lake location.

flywheelNameRequired
string

Name for the flywheel.

activeModelArnOptional
string

The Amazon Resource Number (ARN) of the active model version.

dataSecurityConfigOptional
IResolvable | DataSecurityConfigProperty

Data security configuration.

modelTypeOptional
string

Model type of the flywheel's model.

tagsOptional
CfnTag[]

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.

taskConfigOptional
IResolvable | TaskConfigProperty

Configuration about the model associated with a flywheel.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter