interface CfnFlywheelProps

Language	Type name
.NET	Amazon.CDK.AWS.Comprehend.CfnFlywheelProps
Java	software.amazon.awscdk.services.comprehend.CfnFlywheelProps
Python	aws_cdk.aws_comprehend.CfnFlywheelProps
TypeScript	@aws-cdk/aws-comprehend » CfnFlywheelProps

Properties for defining a CfnFlywheel.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as comprehend from '@aws-cdk/aws-comprehend';
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

Name	Type	Description
dataAccessRoleArn	string	The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to access the flywheel data.
dataLakeS3Uri	string	Amazon S3 URI of the data lake location.
flywheelName	string	Name for the flywheel.
activeModelArn?	string	The Amazon Resource Number (ARN) of the active model version.
dataSecurityConfig?	DataSecurityConfigProperty | IResolvable	Data security configuration.
modelType?	string	Model type of the flywheel's model.
tags?	CfnTag[]	Tags associated with the endpoint being created.
taskConfig?	IResolvable | TaskConfigProperty	Configuration about the model associated with a flywheel.

---

dataAccessRoleArn

Type: string

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

---

dataLakeS3Uri

Type: string

Amazon S3 URI of the data lake location.

---

flywheelName

Type: string

Name for the flywheel.

---

activeModelArn?

Type: string (optional)

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

---

dataSecurityConfig?

Type: DataSecurityConfigProperty | IResolvable (optional)

Data security configuration.

---

modelType?

Type: string (optional)

Model type of the flywheel's model.

---

tags?

Type: CfnTag[] (optional)

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?

Type: IResolvable | TaskConfigProperty (optional)

Configuration about the model associated with a flywheel.