CfnFlywheelProps Struct
Properties for defining a CfnFlywheel.
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
activeModelArnoptionalstringactive_model_arnoptionalstractiveModelArnoptionalStringActiveModelArnoptionalstringActiveModelArnoptional*string#The Amazon Resource Number (ARN) of the active model version.
dataAccessRoleArnstringdata_access_role_arnstrdataAccessRoleArnStringDataAccessRoleArnstringDataAccessRoleArn*stringrequired#The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to access the flywheel data.
dataLakeS3Uristringdata_lake_s3_uristrdataLakeS3UriStringDataLakeS3UristringDataLakeS3Uri*stringrequired#Amazon S3 URI of the data lake location.
dataSecurityConfigoptionalIResolvable | CfnFlywheel.DataSecurityConfigPropertydata_security_configoptionaltyping.Union[IResolvable, DataSecurityConfigProperty]dataSecurityConfigoptionalIResolvableDataSecurityConfigoptionalIResolvableDataSecurityConfigoptionalinterface{}#Data security configuration.
Name for the flywheel.
modelTypeoptionalstringmodel_typeoptionalstrmodelTypeoptionalStringModelTypeoptionalstringModelTypeoptional*string#Model type of the flywheel's model.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]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.
taskConfigoptionalIResolvable | CfnFlywheel.TaskConfigPropertytask_configoptionaltyping.Union[IResolvable, TaskConfigProperty]taskConfigoptionalIResolvableTaskConfigoptionalIResolvableTaskConfigoptionalinterface{}#Configuration about the model associated with a flywheel.