1. Packages
  2. AWS Native
  3. API Docs
  4. comprehend
  5. Flywheel

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

aws-native.comprehend.Flywheel

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

    The AWS::Comprehend::Flywheel resource creates an Amazon Comprehend Flywheel that enables customer to train their model.

    Create Flywheel Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Flywheel(name: string, args: FlywheelArgs, opts?: CustomResourceOptions);
    @overload
    def Flywheel(resource_name: str,
                 args: FlywheelArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Flywheel(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 data_access_role_arn: Optional[str] = None,
                 data_lake_s3_uri: Optional[str] = None,
                 active_model_arn: Optional[str] = None,
                 data_security_config: Optional[FlywheelDataSecurityConfigArgs] = None,
                 flywheel_name: Optional[str] = None,
                 model_type: Optional[FlywheelModelType] = None,
                 tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                 task_config: Optional[FlywheelTaskConfigArgs] = None)
    func NewFlywheel(ctx *Context, name string, args FlywheelArgs, opts ...ResourceOption) (*Flywheel, error)
    public Flywheel(string name, FlywheelArgs args, CustomResourceOptions? opts = null)
    public Flywheel(String name, FlywheelArgs args)
    public Flywheel(String name, FlywheelArgs args, CustomResourceOptions options)
    
    type: aws-native:comprehend:Flywheel
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args FlywheelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args FlywheelArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args FlywheelArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FlywheelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FlywheelArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const flywheelResource = new aws_native.comprehend.Flywheel("flywheelResource", {
        dataAccessRoleArn: "string",
        dataLakeS3Uri: "string",
        activeModelArn: "string",
        dataSecurityConfig: {
            dataLakeKmsKeyId: "string",
            modelKmsKeyId: "string",
            volumeKmsKeyId: "string",
            vpcConfig: {
                securityGroupIds: ["string"],
                subnets: ["string"],
            },
        },
        flywheelName: "string",
        modelType: aws_native.comprehend.FlywheelModelType.DocumentClassifier,
        tags: [{
            key: "string",
            value: "string",
        }],
        taskConfig: {
            languageCode: aws_native.comprehend.FlywheelTaskConfigLanguageCode.En,
            documentClassificationConfig: {
                mode: aws_native.comprehend.FlywheelDocumentClassificationConfigMode.MultiClass,
                labels: ["string"],
            },
            entityRecognitionConfig: {
                entityTypes: [{
                    type: "string",
                }],
            },
        },
    });
    
    Coming soon!
    

    Flywheel Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Flywheel resource accepts the following input properties:

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Flywheel resource produces the following output properties:

    Arn string
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    FlywheelDataSecurityConfig, FlywheelDataSecurityConfigArgs

    FlywheelDocumentClassificationConfig, FlywheelDocumentClassificationConfigArgs

    FlywheelDocumentClassificationConfigMode, FlywheelDocumentClassificationConfigModeArgs

    MultiClass
    MULTI_CLASS
    MultiLabel
    MULTI_LABEL
    FlywheelDocumentClassificationConfigModeMultiClass
    MULTI_CLASS
    FlywheelDocumentClassificationConfigModeMultiLabel
    MULTI_LABEL
    MultiClass
    MULTI_CLASS
    MultiLabel
    MULTI_LABEL
    MultiClass
    MULTI_CLASS
    MultiLabel
    MULTI_LABEL
    MULTI_CLASS
    MULTI_CLASS
    MULTI_LABEL
    MULTI_LABEL
    "MULTI_CLASS"
    MULTI_CLASS
    "MULTI_LABEL"
    MULTI_LABEL

    FlywheelEntityRecognitionConfig, FlywheelEntityRecognitionConfigArgs

    FlywheelEntityTypesListItem, FlywheelEntityTypesListItemArgs

    Type string
    Type string
    type String
    type string
    type str
    type String

    FlywheelModelType, FlywheelModelTypeArgs

    DocumentClassifier
    DOCUMENT_CLASSIFIER
    EntityRecognizer
    ENTITY_RECOGNIZER
    FlywheelModelTypeDocumentClassifier
    DOCUMENT_CLASSIFIER
    FlywheelModelTypeEntityRecognizer
    ENTITY_RECOGNIZER
    DocumentClassifier
    DOCUMENT_CLASSIFIER
    EntityRecognizer
    ENTITY_RECOGNIZER
    DocumentClassifier
    DOCUMENT_CLASSIFIER
    EntityRecognizer
    ENTITY_RECOGNIZER
    DOCUMENT_CLASSIFIER
    DOCUMENT_CLASSIFIER
    ENTITY_RECOGNIZER
    ENTITY_RECOGNIZER
    "DOCUMENT_CLASSIFIER"
    DOCUMENT_CLASSIFIER
    "ENTITY_RECOGNIZER"
    ENTITY_RECOGNIZER

    FlywheelTaskConfig, FlywheelTaskConfigArgs

    FlywheelTaskConfigLanguageCode, FlywheelTaskConfigLanguageCodeArgs

    En
    en
    Es
    es
    Fr
    fr
    It
    it
    De
    de
    Pt
    pt
    FlywheelTaskConfigLanguageCodeEn
    en
    FlywheelTaskConfigLanguageCodeEs
    es
    FlywheelTaskConfigLanguageCodeFr
    fr
    FlywheelTaskConfigLanguageCodeIt
    it
    FlywheelTaskConfigLanguageCodeDe
    de
    FlywheelTaskConfigLanguageCodePt
    pt
    En
    en
    Es
    es
    Fr
    fr
    It
    it
    De
    de
    Pt
    pt
    En
    en
    Es
    es
    Fr
    fr
    It
    it
    De
    de
    Pt
    pt
    EN
    en
    ES
    es
    FR
    fr
    IT
    it
    DE
    de
    PT
    pt
    "en"
    en
    "es"
    es
    "fr"
    fr
    "it"
    it
    "de"
    de
    "pt"
    pt

    FlywheelVpcConfig, FlywheelVpcConfigArgs

    SecurityGroupIds List<string>
    Subnets List<string>
    SecurityGroupIds []string
    Subnets []string
    securityGroupIds List<String>
    subnets List<String>
    securityGroupIds string[]
    subnets string[]
    security_group_ids Sequence[str]
    subnets Sequence[str]
    securityGroupIds List<String>
    subnets List<String>

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi