CfnFlywheelMixinProps

class aws_cdk.mixins_preview.aws_comprehend.mixins.CfnFlywheelMixinProps(*, active_model_arn=None, data_access_role_arn=None, data_lake_s3_uri=None, data_security_config=None, flywheel_name=None, model_type=None, tags=None, task_config=None)

Bases: object

Properties for CfnFlywheelPropsMixin.

Parameters:

  • active_model_arn (Optional[str]) – The Amazon Resource Number (ARN) of the active model version.

  • data_access_role_arn (Optional[str]) – The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to access the flywheel data.

  • data_lake_s3_uri (Optional[str]) – Amazon S3 URI of the data lake location.

  • data_security_config (Union[IResolvable, DataSecurityConfigProperty, Dict[str, Any], None]) – Data security configuration.

  • flywheel_name (Optional[str]) – Name for the flywheel.

  • model_type (Optional[str]) – Model type of the flywheel’s model.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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.

  • task_config (Union[IResolvable, TaskConfigProperty, Dict[str, Any], None]) – Configuration about the model associated with a flywheel.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-flywheel.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_comprehend import mixins as comprehend_mixins

cfn_flywheel_mixin_props = comprehend_mixins.CfnFlywheelMixinProps(
    active_model_arn="activeModelArn",
    data_access_role_arn="dataAccessRoleArn",
    data_lake_s3_uri="dataLakeS3Uri",
    data_security_config=comprehend_mixins.CfnFlywheelPropsMixin.DataSecurityConfigProperty(
        data_lake_kms_key_id="dataLakeKmsKeyId",
        model_kms_key_id="modelKmsKeyId",
        volume_kms_key_id="volumeKmsKeyId",
        vpc_config=comprehend_mixins.CfnFlywheelPropsMixin.VpcConfigProperty(
            security_group_ids=["securityGroupIds"],
            subnets=["subnets"]
        )
    ),
    flywheel_name="flywheelName",
    model_type="modelType",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    task_config=comprehend_mixins.CfnFlywheelPropsMixin.TaskConfigProperty(
        document_classification_config=comprehend_mixins.CfnFlywheelPropsMixin.DocumentClassificationConfigProperty(
            labels=["labels"],
            mode="mode"
        ),
        entity_recognition_config=comprehend_mixins.CfnFlywheelPropsMixin.EntityRecognitionConfigProperty(
            entity_types=[comprehend_mixins.CfnFlywheelPropsMixin.EntityTypesListItemProperty(
                type="type"
            )]
        ),
        language_code="languageCode"
    )
)

Attributes

active_model_arn

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

See:

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

data_access_role_arn

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

See:

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

data_lake_s3_uri

Amazon S3 URI of the data lake location.

See:

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

data_security_config

Data security configuration.

See:

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

flywheel_name

Name for the flywheel.

See:

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

model_type

Model type of the flywheel’s model.

See:

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

tags

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:

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

task_config

Configuration about the model associated with a flywheel.

See:

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