interface CfnFlywheelMixinProps

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

Properties for CfnFlywheelPropsMixin.

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 as comprehend_mixins } from '@aws-cdk/mixins-preview/aws-comprehend';
const cfnFlywheelMixinProps: comprehend_mixins.CfnFlywheelMixinProps = {
  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',
  },
};

Properties

Name	Type	Description
activeModelArn?	string	The Amazon Resource Number (ARN) of the active model version.
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.
dataSecurityConfig?	IResolvable | DataSecurityConfigProperty	Data security configuration.
flywheelName?	string	Name for the flywheel.
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.

---

activeModelArn?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-flywheel.html#cfn-comprehend-flywheel-activemodelarn

---

dataAccessRoleArn?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-flywheel.html#cfn-comprehend-flywheel-dataaccessrolearn

---

dataLakeS3Uri?

Type: string (optional)

Amazon S3 URI of the data lake location.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-flywheel.html#cfn-comprehend-flywheel-datalakes3uri

---

dataSecurityConfig?

Type: IResolvable | DataSecurityConfigProperty (optional)

Data security configuration.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-flywheel.html#cfn-comprehend-flywheel-datasecurityconfig

---

flywheelName?

Type: string (optional)

Name for the flywheel.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-flywheel.html#cfn-comprehend-flywheel-flywheelname

---

modelType?

Type: string (optional)

Model type of the flywheel's model.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-flywheel.html#cfn-comprehend-flywheel-modeltype

---

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-flywheel.html#cfn-comprehend-flywheel-tags

---

taskConfig?

Type: IResolvable | TaskConfigProperty (optional)

Configuration about the model associated with a flywheel.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-flywheel.html#cfn-comprehend-flywheel-taskconfig