awscomprehend

package
v2.142.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 17, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

README

AWS::Comprehend Construct Library

This module is part of the AWS Cloud Development Kit project.

import comprehend "github.com/aws/aws-cdk-go/awscdk"

There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:

There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::Comprehend.

(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CfnDocumentClassifier_CFN_RESOURCE_TYPE_NAME added in v2.87.0 

func CfnDocumentClassifier_CFN_RESOURCE_TYPE_NAME() *string

func CfnDocumentClassifier_IsCfnElement added in v2.87.0 

func CfnDocumentClassifier_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnDocumentClassifier_IsCfnResource added in v2.87.0 

func CfnDocumentClassifier_IsCfnResource(x interface{}) *bool

Check whether the given object is a CfnResource.

func CfnDocumentClassifier_IsConstruct added in v2.87.0 

func CfnDocumentClassifier_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

Returns: true if `x` is an object created from a class which extends `Construct`.

func CfnFlywheel_CFN_RESOURCE_TYPE_NAME 

func CfnFlywheel_CFN_RESOURCE_TYPE_NAME() *string

func CfnFlywheel_IsCfnElement 

func CfnFlywheel_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnFlywheel_IsCfnResource 

func CfnFlywheel_IsCfnResource(x interface{}) *bool

Check whether the given object is a CfnResource.

func CfnFlywheel_IsConstruct 

func CfnFlywheel_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

Returns: true if `x` is an object created from a class which extends `Construct`.

func NewCfnDocumentClassifier_Override added in v2.87.0 

func NewCfnDocumentClassifier_Override(c CfnDocumentClassifier, scope constructs.Construct, id *string, props *CfnDocumentClassifierProps)

func NewCfnFlywheel_Override 

func NewCfnFlywheel_Override(c CfnFlywheel, scope constructs.Construct, id *string, props *CfnFlywheelProps)

Types

type CfnDocumentClassifier added in v2.87.0 

type CfnDocumentClassifier interface {
	awscdk.CfnResource
	awscdk.IInspectable
	awscdk.ITaggableV2
	// The Amazon Resource Name (ARN) of the document classifier.
	AttrArn() *string
	// Tag Manager which manages the tags for this resource.
	CdkTagManager() awscdk.TagManager
	// Options for this resource, such as condition, update policy etc.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	CfnResourceType() *string
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	// The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
	DataAccessRoleArn() *string
	SetDataAccessRoleArn(val *string)
	// The name of the document classifier.
	DocumentClassifierName() *string
	SetDocumentClassifierName(val *string)
	// Specifies the format and location of the input data for the job.
	InputDataConfig() interface{}
	SetInputDataConfig(val interface{})
	// The language of the input documents.
	LanguageCode() *string
	SetLanguageCode(val *string)
	// The logical ID for this CloudFormation stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	// Indicates the mode in which the classifier will be trained.
	Mode() *string
	SetMode(val *string)
	// ID for the AWS KMS key that Amazon Comprehend uses to encrypt trained custom models.
	ModelKmsKeyId() *string
	SetModelKmsKeyId(val *string)
	// The resource-based policy to attach to your custom document classifier model.
	ModelPolicy() *string
	SetModelPolicy(val *string)
	// The tree node.
	Node() constructs.Node
	// Provides output results configuration parameters for custom classifier jobs.
	OutputDataConfig() interface{}
	SetOutputDataConfig(val interface{})
	// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	Ref() *string
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	Stack() awscdk.Stack
	// Tags to associate with the document classifier.
	Tags() *[]*awscdk.CfnTag
	SetTags(val *[]*awscdk.CfnTag)
	// Deprecated.
	// Deprecated: use `updatedProperties`
	//
	// Return properties modified after initiation
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperties() *map[string]interface{}
	// The version name given to the newly created classifier.
	VersionName() *string
	SetVersionName(val *string)
	// ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job.
	VolumeKmsKeyId() *string
	SetVolumeKmsKeyId(val *string)
	// Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier.
	VpcConfig() interface{}
	SetVpcConfig(val interface{})
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	AddDependency(target awscdk.CfnResource)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	// Deprecated: use addDependency.
	AddDependsOn(target awscdk.CfnResource)
	// Add a value to the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	AddMetadata(key *string, value interface{})
	// Adds an override to the synthesized CloudFormation resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// To include a literal `.` in the property name, prefix with a `\`. In most
	// programming languages you will need to write this as `"\\."` because the
	// `\` itself will need to be escaped.
	//
	// For example,
	// “`typescript
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//   "GlobalSecondaryIndexes": [
	//     {
	//       "Projection": {
	//         "NonKeyAttributes": [ "myattribute" ]
	//         ...
	//       }
	//       ...
	//     },
	//     {
	//       "ProjectionType": "INCLUDE"
	//       ...
	//     },
	//   ]
	//   ...
	// }
	// “`
	//
	// The `value` argument to `addOverride` will not be processed or translated
	// in any way. Pass raw JSON values in here with the correct capitalization
	// for CloudFormation. If you pass CDK classes or structs, they will be
	// rendered with lowercased key names, and CloudFormation will reject the
	// template.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	// Sets the deletion policy of the resource based on the removal policy specified.
	//
	// The Removal Policy controls what happens to this resource when it stops
	// being managed by CloudFormation, either because you've removed it from the
	// CDK application or because you've made a change that requires the resource
	// to be replaced.
	//
	// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
	// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
	// cases, a snapshot can be taken of the resource prior to deletion
	// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
	// can be found in the following link:.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
	//
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
	// Retrieve a value value from the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Retrieves an array of resources this resource depends on.
	//
	// This assembles dependencies on resources across stacks (including nested stacks)
	// automatically.
	ObtainDependencies() *[]interface{}
	// Get a shallow copy of dependencies between this resource and other resources in the same stack.
	ObtainResourceDependencies() *[]awscdk.CfnResource
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Indicates that this resource no longer depends on another resource.
	//
	// This can be used for resources across stacks (including nested stacks)
	// and the dependency will automatically be removed from the relevant scope.
	RemoveDependency(target awscdk.CfnResource)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// Replaces one dependency with another.
	ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
	// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
	//
	// Returns: `true` if the resource should be included or `false` is the resource
	// should be omitted.
	ShouldSynthesize() *bool
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	ValidateProperties(_properties interface{})
}

This resource creates and trains a document classifier to categorize documents.

You provide a set of training documents that are labeled with the categories that you want to identify. After the classifier is trained you can use it to categorize a set of labeled documents into the categories. For more information, see [Document Classification](https://docs.aws.amazon.com/comprehend/latest/dg/how-document-classification.html) in the Comprehend Developer Guide.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnDocumentClassifier := awscdk.Aws_comprehend.NewCfnDocumentClassifier(this, jsii.String("MyCfnDocumentClassifier"), &CfnDocumentClassifierProps{
	DataAccessRoleArn: jsii.String("dataAccessRoleArn"),
	DocumentClassifierName: jsii.String("documentClassifierName"),
	InputDataConfig: &DocumentClassifierInputDataConfigProperty{
		AugmentedManifests: []interface{}{
			&AugmentedManifestsListItemProperty{
				AttributeNames: []*string{
					jsii.String("attributeNames"),
				},
				S3Uri: jsii.String("s3Uri"),

				// the properties below are optional
				Split: jsii.String("split"),
			},
		},
		DataFormat: jsii.String("dataFormat"),
		DocumentReaderConfig: &DocumentReaderConfigProperty{
			DocumentReadAction: jsii.String("documentReadAction"),

			// the properties below are optional
			DocumentReadMode: jsii.String("documentReadMode"),
			FeatureTypes: []*string{
				jsii.String("featureTypes"),
			},
		},
		Documents: &DocumentClassifierDocumentsProperty{
			S3Uri: jsii.String("s3Uri"),

			// the properties below are optional
			TestS3Uri: jsii.String("testS3Uri"),
		},
		DocumentType: jsii.String("documentType"),
		LabelDelimiter: jsii.String("labelDelimiter"),
		S3Uri: jsii.String("s3Uri"),
		TestS3Uri: jsii.String("testS3Uri"),
	},
	LanguageCode: jsii.String("languageCode"),

	// the properties below are optional
	Mode: jsii.String("mode"),
	ModelKmsKeyId: jsii.String("modelKmsKeyId"),
	ModelPolicy: jsii.String("modelPolicy"),
	OutputDataConfig: &DocumentClassifierOutputDataConfigProperty{
		KmsKeyId: jsii.String("kmsKeyId"),
		S3Uri: jsii.String("s3Uri"),
	},
	Tags: []cfnTag{
		&cfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
	VersionName: jsii.String("versionName"),
	VolumeKmsKeyId: jsii.String("volumeKmsKeyId"),
	VpcConfig: &VpcConfigProperty{
		SecurityGroupIds: []*string{
			jsii.String("securityGroupIds"),
		},
		Subnets: []*string{
			jsii.String("subnets"),
		},
	},
})

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

func NewCfnDocumentClassifier added in v2.87.0 

func NewCfnDocumentClassifier(scope constructs.Construct, id *string, props *CfnDocumentClassifierProps) CfnDocumentClassifier

type CfnDocumentClassifierProps added in v2.87.0 

type CfnDocumentClassifierProps struct {
	// The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-dataaccessrolearn
	//
	DataAccessRoleArn *string `field:"required" json:"dataAccessRoleArn" yaml:"dataAccessRoleArn"`
	// The name of the document classifier.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-documentclassifiername
	//
	DocumentClassifierName *string `field:"required" json:"documentClassifierName" yaml:"documentClassifierName"`
	// Specifies the format and location of the input data for the job.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-inputdataconfig
	//
	InputDataConfig interface{} `field:"required" json:"inputDataConfig" yaml:"inputDataConfig"`
	// The language of the input documents.
	//
	// You can specify any of the languages supported by Amazon Comprehend. All documents must be in the same language.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-languagecode
	//
	LanguageCode *string `field:"required" json:"languageCode" yaml:"languageCode"`
	// Indicates the mode in which the classifier will be trained.
	//
	// The classifier can be trained in multi-class (single-label) mode or multi-label mode. Multi-class mode identifies a single class label for each document and multi-label mode identifies one or more class labels for each document. Multiple labels for an individual document are separated by a delimiter. The default delimiter between labels is a pipe (|).
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-mode
	//
	Mode *string `field:"optional" json:"mode" yaml:"mode"`
	// ID for the AWS KMS key that Amazon Comprehend uses to encrypt trained custom models.
	//
	// The ModelKmsKeyId can be either of the following formats:
	//
	// - KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
	// - Amazon Resource Name (ARN) of a KMS Key: `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-modelkmskeyid
	//
	ModelKmsKeyId *string `field:"optional" json:"modelKmsKeyId" yaml:"modelKmsKeyId"`
	// The resource-based policy to attach to your custom document classifier model.
	//
	// You can use this policy to allow another AWS account to import your custom model.
	//
	// Provide your policy as a JSON body that you enter as a UTF-8 encoded string without line breaks. To provide valid JSON, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:
	//
	// `"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"`
	//
	// To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:
	//
	// `'{"attribute": "value", "attribute": ["value"]}'`.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-modelpolicy
	//
	ModelPolicy *string `field:"optional" json:"modelPolicy" yaml:"modelPolicy"`
	// Provides output results configuration parameters for custom classifier jobs.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-outputdataconfig
	//
	OutputDataConfig interface{} `field:"optional" json:"outputDataConfig" yaml:"outputDataConfig"`
	// Tags to associate with the document classifier.
	//
	// A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-tags
	//
	Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
	// The version name given to the newly created classifier.
	//
	// Version names can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same classifier name in the AWS account / AWS Region .
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-versionname
	//
	VersionName *string `field:"optional" json:"versionName" yaml:"versionName"`
	// ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job.
	//
	// The VolumeKmsKeyId can be either of the following formats:
	//
	// - KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
	// - Amazon Resource Name (ARN) of a KMS Key: `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-volumekmskeyid
	//
	VolumeKmsKeyId *string `field:"optional" json:"volumeKmsKeyId" yaml:"volumeKmsKeyId"`
	// Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier.
	//
	// For more information, see [Amazon VPC](https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html) .
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-vpcconfig
	//
	VpcConfig interface{} `field:"optional" json:"vpcConfig" yaml:"vpcConfig"`
}

Properties for defining a `CfnDocumentClassifier`.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnDocumentClassifierProps := &CfnDocumentClassifierProps{
	DataAccessRoleArn: jsii.String("dataAccessRoleArn"),
	DocumentClassifierName: jsii.String("documentClassifierName"),
	InputDataConfig: &DocumentClassifierInputDataConfigProperty{
		AugmentedManifests: []interface{}{
			&AugmentedManifestsListItemProperty{
				AttributeNames: []*string{
					jsii.String("attributeNames"),
				},
				S3Uri: jsii.String("s3Uri"),

				// the properties below are optional
				Split: jsii.String("split"),
			},
		},
		DataFormat: jsii.String("dataFormat"),
		DocumentReaderConfig: &DocumentReaderConfigProperty{
			DocumentReadAction: jsii.String("documentReadAction"),

			// the properties below are optional
			DocumentReadMode: jsii.String("documentReadMode"),
			FeatureTypes: []*string{
				jsii.String("featureTypes"),
			},
		},
		Documents: &DocumentClassifierDocumentsProperty{
			S3Uri: jsii.String("s3Uri"),

			// the properties below are optional
			TestS3Uri: jsii.String("testS3Uri"),
		},
		DocumentType: jsii.String("documentType"),
		LabelDelimiter: jsii.String("labelDelimiter"),
		S3Uri: jsii.String("s3Uri"),
		TestS3Uri: jsii.String("testS3Uri"),
	},
	LanguageCode: jsii.String("languageCode"),

	// the properties below are optional
	Mode: jsii.String("mode"),
	ModelKmsKeyId: jsii.String("modelKmsKeyId"),
	ModelPolicy: jsii.String("modelPolicy"),
	OutputDataConfig: &DocumentClassifierOutputDataConfigProperty{
		KmsKeyId: jsii.String("kmsKeyId"),
		S3Uri: jsii.String("s3Uri"),
	},
	Tags: []cfnTag{
		&cfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
	VersionName: jsii.String("versionName"),
	VolumeKmsKeyId: jsii.String("volumeKmsKeyId"),
	VpcConfig: &VpcConfigProperty{
		SecurityGroupIds: []*string{
			jsii.String("securityGroupIds"),
		},
		Subnets: []*string{
			jsii.String("subnets"),
		},
	},
}

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

type CfnDocumentClassifier_AugmentedManifestsListItemProperty added in v2.87.0 

type CfnDocumentClassifier_AugmentedManifestsListItemProperty struct {
	// The JSON attribute that contains the annotations for your training documents.
	//
	// The number of attribute names that you specify depends on whether your augmented manifest file is the output of a single labeling job or a chained labeling job.
	//
	// If your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth.
	//
	// If your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-augmentedmanifestslistitem.html#cfn-comprehend-documentclassifier-augmentedmanifestslistitem-attributenames
	//
	AttributeNames *[]*string `field:"required" json:"attributeNames" yaml:"attributeNames"`
	// The Amazon S3 location of the augmented manifest file.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-augmentedmanifestslistitem.html#cfn-comprehend-documentclassifier-augmentedmanifestslistitem-s3uri
	//
	S3Uri *string `field:"required" json:"s3Uri" yaml:"s3Uri"`
	// The purpose of the data you've provided in the augmented manifest.
	//
	// You can either train or test this data. If you don't specify, the default is train.
	//
	// TRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.
	//
	// TEST - all of the documents in the manifest will be used for testing.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-augmentedmanifestslistitem.html#cfn-comprehend-documentclassifier-augmentedmanifestslistitem-split
	//
	Split *string `field:"optional" json:"split" yaml:"split"`
}

An augmented manifest file that provides training data for your custom model.

An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

augmentedManifestsListItemProperty := &AugmentedManifestsListItemProperty{
	AttributeNames: []*string{
		jsii.String("attributeNames"),
	},
	S3Uri: jsii.String("s3Uri"),

	// the properties below are optional
	Split: jsii.String("split"),
}

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-augmentedmanifestslistitem.html

type CfnDocumentClassifier_DocumentClassifierDocumentsProperty added in v2.87.0 

type CfnDocumentClassifier_DocumentClassifierDocumentsProperty struct {
	// The S3 URI location of the training documents specified in the S3Uri CSV file.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierdocuments.html#cfn-comprehend-documentclassifier-documentclassifierdocuments-s3uri
	//
	S3Uri *string `field:"required" json:"s3Uri" yaml:"s3Uri"`
	// The S3 URI location of the test documents included in the TestS3Uri CSV file.
	//
	// This field is not required if you do not specify a test CSV file.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierdocuments.html#cfn-comprehend-documentclassifier-documentclassifierdocuments-tests3uri
	//
	TestS3Uri *string `field:"optional" json:"testS3Uri" yaml:"testS3Uri"`
}

The location of the training documents.

This parameter is required in a request to create a semi-structured document classification model.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

documentClassifierDocumentsProperty := &DocumentClassifierDocumentsProperty{
	S3Uri: jsii.String("s3Uri"),

	// the properties below are optional
	TestS3Uri: jsii.String("testS3Uri"),
}

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierdocuments.html

type CfnDocumentClassifier_DocumentClassifierInputDataConfigProperty added in v2.87.0 

type CfnDocumentClassifier_DocumentClassifierInputDataConfigProperty struct {
	// A list of augmented manifest files that provide training data for your custom model.
	//
	// An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.
	//
	// This parameter is required if you set `DataFormat` to `AUGMENTED_MANIFEST` .
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierinputdataconfig.html#cfn-comprehend-documentclassifier-documentclassifierinputdataconfig-augmentedmanifests
	//
	AugmentedManifests interface{} `field:"optional" json:"augmentedManifests" yaml:"augmentedManifests"`
	// The format of your training data:.
	//
	// - `COMPREHEND_CSV` : A two-column CSV file, where labels are provided in the first column, and documents are provided in the second. If you use this value, you must provide the `S3Uri` parameter in your request.
	// - `AUGMENTED_MANIFEST` : A labeled dataset that is produced by Amazon SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON object that contains a training document and its associated labels.
	//
	// If you use this value, you must provide the `AugmentedManifests` parameter in your request.
	//
	// If you don't specify a value, Amazon Comprehend uses `COMPREHEND_CSV` as the default.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierinputdataconfig.html#cfn-comprehend-documentclassifier-documentclassifierinputdataconfig-dataformat
	//
	DataFormat *string `field:"optional" json:"dataFormat" yaml:"dataFormat"`
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierinputdataconfig.html#cfn-comprehend-documentclassifier-documentclassifierinputdataconfig-documentreaderconfig
	//
	DocumentReaderConfig interface{} `field:"optional" json:"documentReaderConfig" yaml:"documentReaderConfig"`
	// The S3 location of the training documents.
	//
	// This parameter is required in a request to create a native document model.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierinputdataconfig.html#cfn-comprehend-documentclassifier-documentclassifierinputdataconfig-documents
	//
	Documents interface{} `field:"optional" json:"documents" yaml:"documents"`
	// The type of input documents for training the model.
	//
	// Provide plain-text documents to create a plain-text model, and provide semi-structured documents to create a native document model.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierinputdataconfig.html#cfn-comprehend-documentclassifier-documentclassifierinputdataconfig-documenttype
	//
	DocumentType *string `field:"optional" json:"documentType" yaml:"documentType"`
	// Indicates the delimiter used to separate each label for training a multi-label classifier.
	//
	// The default delimiter between labels is a pipe (|). You can use a different character as a delimiter (if it's an allowed character) by specifying it under Delimiter for labels. If the training documents use a delimiter other than the default or the delimiter you specify, the labels on that line will be combined to make a single unique label, such as LABELLABELLABEL.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierinputdataconfig.html#cfn-comprehend-documentclassifier-documentclassifierinputdataconfig-labeldelimiter
	//
	LabelDelimiter *string `field:"optional" json:"labelDelimiter" yaml:"labelDelimiter"`
	// The Amazon S3 URI for the input data.
	//
	// The S3 bucket must be in the same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of input files.
	//
	// For example, if you use the URI `S3://bucketName/prefix` , if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.
	//
	// This parameter is required if you set `DataFormat` to `COMPREHEND_CSV` .
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierinputdataconfig.html#cfn-comprehend-documentclassifier-documentclassifierinputdataconfig-s3uri
	//
	S3Uri *string `field:"optional" json:"s3Uri" yaml:"s3Uri"`
	// This specifies the Amazon S3 location that contains the test annotations for the document classifier.
	//
	// The URI must be in the same AWS Region as the API endpoint that you are calling.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierinputdataconfig.html#cfn-comprehend-documentclassifier-documentclassifierinputdataconfig-tests3uri
	//
	TestS3Uri *string `field:"optional" json:"testS3Uri" yaml:"testS3Uri"`
}

The input properties for training a document classifier.

For more information on how the input file is formatted, see [Preparing training data](https://docs.aws.amazon.com/comprehend/latest/dg/prep-classifier-data.html) in the Comprehend Developer Guide.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

documentClassifierInputDataConfigProperty := &DocumentClassifierInputDataConfigProperty{
	AugmentedManifests: []interface{}{
		&AugmentedManifestsListItemProperty{
			AttributeNames: []*string{
				jsii.String("attributeNames"),
			},
			S3Uri: jsii.String("s3Uri"),

			// the properties below are optional
			Split: jsii.String("split"),
		},
	},
	DataFormat: jsii.String("dataFormat"),
	DocumentReaderConfig: &DocumentReaderConfigProperty{
		DocumentReadAction: jsii.String("documentReadAction"),

		// the properties below are optional
		DocumentReadMode: jsii.String("documentReadMode"),
		FeatureTypes: []*string{
			jsii.String("featureTypes"),
		},
	},
	Documents: &DocumentClassifierDocumentsProperty{
		S3Uri: jsii.String("s3Uri"),

		// the properties below are optional
		TestS3Uri: jsii.String("testS3Uri"),
	},
	DocumentType: jsii.String("documentType"),
	LabelDelimiter: jsii.String("labelDelimiter"),
	S3Uri: jsii.String("s3Uri"),
	TestS3Uri: jsii.String("testS3Uri"),
}

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifierinputdataconfig.html

type CfnDocumentClassifier_DocumentClassifierOutputDataConfigProperty added in v2.87.0 

type CfnDocumentClassifier_DocumentClassifierOutputDataConfigProperty struct {
	// ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job.
	//
	// The KmsKeyId can be one of the following formats:
	//
	// - KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
	// - Amazon Resource Name (ARN) of a KMS Key: `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`
	// - KMS Key Alias: `"alias/ExampleAlias"`
	// - ARN of a KMS Key Alias: `"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"`.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifieroutputdataconfig.html#cfn-comprehend-documentclassifier-documentclassifieroutputdataconfig-kmskeyid
	//
	KmsKeyId *string `field:"optional" json:"kmsKeyId" yaml:"kmsKeyId"`
	// When you use the `OutputDataConfig` object while creating a custom classifier, you specify the Amazon S3 location where you want to write the confusion matrix and other output files.
	//
	// The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of this output file.
	//
	// When the custom classifier job is finished, the service creates the output file in a directory specific to the job. The `S3Uri` field contains the location of the output file, called `output.tar.gz` . It is a compressed archive that contains the confusion matrix.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifieroutputdataconfig.html#cfn-comprehend-documentclassifier-documentclassifieroutputdataconfig-s3uri
	//
	S3Uri *string `field:"optional" json:"s3Uri" yaml:"s3Uri"`
}

Provide the location for output data from a custom classifier job.

This field is mandatory if you are training a native document model.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

documentClassifierOutputDataConfigProperty := &DocumentClassifierOutputDataConfigProperty{
	KmsKeyId: jsii.String("kmsKeyId"),
	S3Uri: jsii.String("s3Uri"),
}

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentclassifieroutputdataconfig.html

type CfnDocumentClassifier_DocumentReaderConfigProperty added in v2.87.0 

type CfnDocumentClassifier_DocumentReaderConfigProperty struct {
	// This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files.
	//
	// Enter one of the following values:
	//
	// - `TEXTRACT_DETECT_DOCUMENT_TEXT` - The Amazon Comprehend service uses the `DetectDocumentText` API operation.
	// - `TEXTRACT_ANALYZE_DOCUMENT` - The Amazon Comprehend service uses the `AnalyzeDocument` API operation.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentreaderconfig.html#cfn-comprehend-documentclassifier-documentreaderconfig-documentreadaction
	//
	DocumentReadAction *string `field:"required" json:"documentReadAction" yaml:"documentReadAction"`
	// Determines the text extraction actions for PDF files. Enter one of the following values:.
	//
	// - `SERVICE_DEFAULT` - use the Amazon Comprehend service defaults for PDF files.
	// - `FORCE_DOCUMENT_READ_ACTION` - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentreaderconfig.html#cfn-comprehend-documentclassifier-documentreaderconfig-documentreadmode
	//
	DocumentReadMode *string `field:"optional" json:"documentReadMode" yaml:"documentReadMode"`
	// Specifies the type of Amazon Textract features to apply.
	//
	// If you chose `TEXTRACT_ANALYZE_DOCUMENT` as the read action, you must specify one or both of the following values:
	//
	// - `TABLES` - Returns additional information about any tables that are detected in the input document.
	// - `FORMS` - Returns additional information about any forms that are detected in the input document.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentreaderconfig.html#cfn-comprehend-documentclassifier-documentreaderconfig-featuretypes
	//
	FeatureTypes *[]*string `field:"optional" json:"featureTypes" yaml:"featureTypes"`
}

Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

By default, Amazon Comprehend performs the following actions to extract text from files, based on the input file type:

- *Word files* - Amazon Comprehend parser extracts the text. - *Digital PDF files* - Amazon Comprehend parser extracts the text. - *Image files and scanned PDF files* - Amazon Comprehend uses the Amazon Textract `DetectDocumentText` API to extract the text.

`DocumentReaderConfig` does not apply to plain text files or Word files.

For image files and PDF documents, you can override these default actions using the fields listed below. For more information, see [Setting text extraction options](https://docs.aws.amazon.com/comprehend/latest/dg/idp-set-textract-options.html) in the Comprehend Developer Guide.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

documentReaderConfigProperty := &DocumentReaderConfigProperty{
	DocumentReadAction: jsii.String("documentReadAction"),

	// the properties below are optional
	DocumentReadMode: jsii.String("documentReadMode"),
	FeatureTypes: []*string{
		jsii.String("featureTypes"),
	},
}

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-documentreaderconfig.html

type CfnDocumentClassifier_VpcConfigProperty added in v2.87.0 

type CfnDocumentClassifier_VpcConfigProperty struct {
	// The ID number for a security group on an instance of your private VPC.
	//
	// Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see [Security Groups for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) .
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-vpcconfig.html#cfn-comprehend-documentclassifier-vpcconfig-securitygroupids
	//
	SecurityGroupIds *[]*string `field:"required" json:"securityGroupIds" yaml:"securityGroupIds"`
	// The ID for each subnet being used in your private VPC.
	//
	// This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see [VPCs and Subnets](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html) .
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-vpcconfig.html#cfn-comprehend-documentclassifier-vpcconfig-subnets
	//
	Subnets *[]*string `field:"required" json:"subnets" yaml:"subnets"`
}

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job.

For more information, see [Amazon VPC](https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html) .

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

vpcConfigProperty := &VpcConfigProperty{
	SecurityGroupIds: []*string{
		jsii.String("securityGroupIds"),
	},
	Subnets: []*string{
		jsii.String("subnets"),
	},
}

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-documentclassifier-vpcconfig.html

type CfnFlywheel 

type CfnFlywheel interface {
	awscdk.CfnResource
	awscdk.IInspectable
	awscdk.ITaggable
	// The Amazon Resource Number (ARN) of the active model version.
	ActiveModelArn() *string
	SetActiveModelArn(val *string)
	// The Amazon Resource Name (ARN) of the flywheel.
	AttrArn() *string
	// Options for this resource, such as condition, update policy etc.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	CfnResourceType() *string
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	// The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to access the flywheel data.
	DataAccessRoleArn() *string
	SetDataAccessRoleArn(val *string)
	// Amazon S3 URI of the data lake location.
	DataLakeS3Uri() *string
	SetDataLakeS3Uri(val *string)
	// Data security configuration.
	DataSecurityConfig() interface{}
	SetDataSecurityConfig(val interface{})
	// Name for the flywheel.
	FlywheelName() *string
	SetFlywheelName(val *string)
	// The logical ID for this CloudFormation stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	// Model type of the flywheel's model.
	ModelType() *string
	SetModelType(val *string)
	// The tree node.
	Node() constructs.Node
	// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	Ref() *string
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	Stack() awscdk.Stack
	// Tag Manager which manages the tags for this resource.
	Tags() awscdk.TagManager
	// Tags associated with the endpoint being created.
	TagsRaw() *[]*awscdk.CfnTag
	SetTagsRaw(val *[]*awscdk.CfnTag)
	// Configuration about the model associated with a flywheel.
	TaskConfig() interface{}
	SetTaskConfig(val interface{})
	// Deprecated.
	// Deprecated: use `updatedProperties`
	//
	// Return properties modified after initiation
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperties() *map[string]interface{}
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	AddDependency(target awscdk.CfnResource)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	// Deprecated: use addDependency.
	AddDependsOn(target awscdk.CfnResource)
	// Add a value to the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	AddMetadata(key *string, value interface{})
	// Adds an override to the synthesized CloudFormation resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// To include a literal `.` in the property name, prefix with a `\`. In most
	// programming languages you will need to write this as `"\\."` because the
	// `\` itself will need to be escaped.
	//
	// For example,
	// “`typescript
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//   "GlobalSecondaryIndexes": [
	//     {
	//       "Projection": {
	//         "NonKeyAttributes": [ "myattribute" ]
	//         ...
	//       }
	//       ...
	//     },
	//     {
	//       "ProjectionType": "INCLUDE"
	//       ...
	//     },
	//   ]
	//   ...
	// }
	// “`
	//
	// The `value` argument to `addOverride` will not be processed or translated
	// in any way. Pass raw JSON values in here with the correct capitalization
	// for CloudFormation. If you pass CDK classes or structs, they will be
	// rendered with lowercased key names, and CloudFormation will reject the
	// template.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	// Sets the deletion policy of the resource based on the removal policy specified.
	//
	// The Removal Policy controls what happens to this resource when it stops
	// being managed by CloudFormation, either because you've removed it from the
	// CDK application or because you've made a change that requires the resource
	// to be replaced.
	//
	// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
	// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
	// cases, a snapshot can be taken of the resource prior to deletion
	// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
	// can be found in the following link:.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
	//
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
	// Retrieve a value value from the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Retrieves an array of resources this resource depends on.
	//
	// This assembles dependencies on resources across stacks (including nested stacks)
	// automatically.
	ObtainDependencies() *[]interface{}
	// Get a shallow copy of dependencies between this resource and other resources in the same stack.
	ObtainResourceDependencies() *[]awscdk.CfnResource
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Indicates that this resource no longer depends on another resource.
	//
	// This can be used for resources across stacks (including nested stacks)
	// and the dependency will automatically be removed from the relevant scope.
	RemoveDependency(target awscdk.CfnResource)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// Replaces one dependency with another.
	ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
	// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
	//
	// Returns: `true` if the resource should be included or `false` is the resource
	// should be omitted.
	ShouldSynthesize() *bool
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	ValidateProperties(_properties interface{})
}

A flywheel is an AWS resource that orchestrates the ongoing training of a model for custom classification or custom entity recognition.

You can create a flywheel to start with an existing trained model, or Comprehend can create and train a new model.

When you create the flywheel, Comprehend creates a data lake in your account. The data lake holds the training data and test data for all versions of the model.

To use a flywheel with an existing trained model, you specify the active model version. Comprehend copies the model's training data and test data into the flywheel's data lake.

To use the flywheel with a new model, you need to provide a dataset for training data (and optional test data) when you create the flywheel.

For more information about flywheels, see [Flywheel overview](https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) in the *Amazon Comprehend Developer Guide* .

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnFlywheel := awscdk.Aws_comprehend.NewCfnFlywheel(this, jsii.String("MyCfnFlywheel"), &CfnFlywheelProps{
	DataAccessRoleArn: jsii.String("dataAccessRoleArn"),
	DataLakeS3Uri: jsii.String("dataLakeS3Uri"),
	FlywheelName: jsii.String("flywheelName"),

	// the properties below are optional
	ActiveModelArn: jsii.String("activeModelArn"),
	DataSecurityConfig: &DataSecurityConfigProperty{
		DataLakeKmsKeyId: jsii.String("dataLakeKmsKeyId"),
		ModelKmsKeyId: jsii.String("modelKmsKeyId"),
		VolumeKmsKeyId: jsii.String("volumeKmsKeyId"),
		VpcConfig: &VpcConfigProperty{
			SecurityGroupIds: []*string{
				jsii.String("securityGroupIds"),
			},
			Subnets: []*string{
				jsii.String("subnets"),
			},
		},
	},
	ModelType: jsii.String("modelType"),
	Tags: []cfnTag{
		&cfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
	TaskConfig: &TaskConfigProperty{
		LanguageCode: jsii.String("languageCode"),

		// the properties below are optional
		DocumentClassificationConfig: &DocumentClassificationConfigProperty{
			Mode: jsii.String("mode"),

			// the properties below are optional
			Labels: []*string{
				jsii.String("labels"),
			},
		},
		EntityRecognitionConfig: &EntityRecognitionConfigProperty{
			EntityTypes: []interface{}{
				&EntityTypesListItemProperty{
					Type: jsii.String("type"),
				},
			},
		},
	},
})

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

func NewCfnFlywheel 

func NewCfnFlywheel(scope constructs.Construct, id *string, props *CfnFlywheelProps) CfnFlywheel

type CfnFlywheelProps 

type CfnFlywheelProps struct {
	// 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
	//
	DataAccessRoleArn *string `field:"required" json:"dataAccessRoleArn" yaml:"dataAccessRoleArn"`
	// 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
	//
	DataLakeS3Uri *string `field:"required" json:"dataLakeS3Uri" yaml:"dataLakeS3Uri"`
	// Name for the flywheel.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-flywheel.html#cfn-comprehend-flywheel-flywheelname
	//
	FlywheelName *string `field:"required" json:"flywheelName" yaml:"flywheelName"`
	// 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
	//
	ActiveModelArn *string `field:"optional" json:"activeModelArn" yaml:"activeModelArn"`
	// Data security configuration.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-flywheel.html#cfn-comprehend-flywheel-datasecurityconfig
	//
	DataSecurityConfig interface{} `field:"optional" json:"dataSecurityConfig" yaml:"dataSecurityConfig"`
	// 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
	//
	ModelType *string `field:"optional" json:"modelType" yaml:"modelType"`
	// 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
	//
	Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
	// 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
	//
	TaskConfig interface{} `field:"optional" json:"taskConfig" yaml:"taskConfig"`
}

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 "github.com/aws/aws-cdk-go/awscdk"

cfnFlywheelProps := &CfnFlywheelProps{
	DataAccessRoleArn: jsii.String("dataAccessRoleArn"),
	DataLakeS3Uri: jsii.String("dataLakeS3Uri"),
	FlywheelName: jsii.String("flywheelName"),

	// the properties below are optional
	ActiveModelArn: jsii.String("activeModelArn"),
	DataSecurityConfig: &DataSecurityConfigProperty{
		DataLakeKmsKeyId: jsii.String("dataLakeKmsKeyId"),
		ModelKmsKeyId: jsii.String("modelKmsKeyId"),
		VolumeKmsKeyId: jsii.String("volumeKmsKeyId"),
		VpcConfig: &VpcConfigProperty{
			SecurityGroupIds: []*string{
				jsii.String("securityGroupIds"),
			},
			Subnets: []*string{
				jsii.String("subnets"),
			},
		},
	},
	ModelType: jsii.String("modelType"),
	Tags: []cfnTag{
		&cfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
	TaskConfig: &TaskConfigProperty{
		LanguageCode: jsii.String("languageCode"),

		// the properties below are optional
		DocumentClassificationConfig: &DocumentClassificationConfigProperty{
			Mode: jsii.String("mode"),

			// the properties below are optional
			Labels: []*string{
				jsii.String("labels"),
			},
		},
		EntityRecognitionConfig: &EntityRecognitionConfigProperty{
			EntityTypes: []interface{}{
				&EntityTypesListItemProperty{
					Type: jsii.String("type"),
				},
			},
		},
	},
}

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

type CfnFlywheel_DataSecurityConfigProperty 

type CfnFlywheel_DataSecurityConfigProperty struct {
	// ID for the AWS KMS key that Amazon Comprehend uses to encrypt the data in the data lake.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-flywheel-datasecurityconfig.html#cfn-comprehend-flywheel-datasecurityconfig-datalakekmskeyid
	//
	DataLakeKmsKeyId *string `field:"optional" json:"dataLakeKmsKeyId" yaml:"dataLakeKmsKeyId"`
	// ID for the AWS KMS key that Amazon Comprehend uses to encrypt trained custom models.
	//
	// The ModelKmsKeyId can be either of the following formats:
	//
	// - KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
	// - Amazon Resource Name (ARN) of a KMS Key: `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-flywheel-datasecurityconfig.html#cfn-comprehend-flywheel-datasecurityconfig-modelkmskeyid
	//
	ModelKmsKeyId *string `field:"optional" json:"modelKmsKeyId" yaml:"modelKmsKeyId"`
	// ID for the AWS KMS key that Amazon Comprehend uses to encrypt the volume.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-flywheel-datasecurityconfig.html#cfn-comprehend-flywheel-datasecurityconfig-volumekmskeyid
	//
	VolumeKmsKeyId *string `field:"optional" json:"volumeKmsKeyId" yaml:"volumeKmsKeyId"`
	// Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job.
	//
	// For more information, see [Amazon VPC](https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html) .
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-flywheel-datasecurityconfig.html#cfn-comprehend-flywheel-datasecurityconfig-vpcconfig
	//
	VpcConfig interface{} `field:"optional" json:"vpcConfig" yaml:"vpcConfig"`
}

Data security configuration.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

dataSecurityConfigProperty := &DataSecurityConfigProperty{
	DataLakeKmsKeyId: jsii.String("dataLakeKmsKeyId"),
	ModelKmsKeyId: jsii.String("modelKmsKeyId"),
	VolumeKmsKeyId: jsii.String("volumeKmsKeyId"),
	VpcConfig: &VpcConfigProperty{
		SecurityGroupIds: []*string{
			jsii.String("securityGroupIds"),
		},
		Subnets: []*string{
			jsii.String("subnets"),
		},
	},
}

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-flywheel-datasecurityconfig.html

type CfnFlywheel_DocumentClassificationConfigProperty 

type CfnFlywheel_DocumentClassificationConfigProperty struct {
	// Classification mode indicates whether the documents are `MULTI_CLASS` or `MULTI_LABEL` .
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-flywheel-documentclassificationconfig.html#cfn-comprehend-flywheel-documentclassificationconfig-mode
	//
	Mode *string `field:"required" json:"mode" yaml:"mode"`
	// One or more labels to associate with the custom classifier.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-flywheel-documentclassificationconfig.html#cfn-comprehend-flywheel-documentclassificationconfig-labels
	//
	Labels *[]*string `field:"optional" json:"labels" yaml:"labels"`
}

Configuration required for a document classification model.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

documentClassificationConfigProperty := &DocumentClassificationConfigProperty{
	Mode: jsii.String("mode"),

	// the properties below are optional
	Labels: []*string{
		jsii.String("labels"),
	},
}

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-flywheel-documentclassificationconfig.html

type CfnFlywheel_EntityRecognitionConfigProperty 

type CfnFlywheel_EntityRecognitionConfigProperty struct {
	// Up to 25 entity types that the model is trained to recognize.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-flywheel-entityrecognitionconfig.html#cfn-comprehend-flywheel-entityrecognitionconfig-entitytypes
	//
	EntityTypes interface{} `field:"optional" json:"entityTypes" yaml:"entityTypes"`
}

Configuration required for an entity recognition model.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

entityRecognitionConfigProperty := &EntityRecognitionConfigProperty{
	EntityTypes: []interface{}{
		&EntityTypesListItemProperty{
			Type: jsii.String("type"),
		},
	},
}

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-flywheel-entityrecognitionconfig.html

type CfnFlywheel_EntityTypesListItemProperty 

type CfnFlywheel_EntityTypesListItemProperty struct {
	// An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.
	//
	// Entity types must not contain the following invalid characters: \n (line break), \\n (escaped line break, \r (carriage return), \\r (escaped carriage return), \t (tab), \\t (escaped tab), and , (comma).
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-flywheel-entitytypeslistitem.html#cfn-comprehend-flywheel-entitytypeslistitem-type
	//
	Type *string `field:"required" json:"type" yaml:"type"`
}

An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

entityTypesListItemProperty := &EntityTypesListItemProperty{
	Type: jsii.String("type"),
}

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-flywheel-entitytypeslistitem.html

type CfnFlywheel_TaskConfigProperty 

type CfnFlywheel_TaskConfigProperty struct {
	// Language code for the language that the model supports.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-flywheel-taskconfig.html#cfn-comprehend-flywheel-taskconfig-languagecode
	//
	LanguageCode *string `field:"required" json:"languageCode" yaml:"languageCode"`
	// Configuration required for a document classification model.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-flywheel-taskconfig.html#cfn-comprehend-flywheel-taskconfig-documentclassificationconfig
	//
	DocumentClassificationConfig interface{} `field:"optional" json:"documentClassificationConfig" yaml:"documentClassificationConfig"`
	// Configuration required for an entity recognition model.
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-flywheel-taskconfig.html#cfn-comprehend-flywheel-taskconfig-entityrecognitionconfig
	//
	EntityRecognitionConfig interface{} `field:"optional" json:"entityRecognitionConfig" yaml:"entityRecognitionConfig"`
}

Configuration about the model associated with a flywheel.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

taskConfigProperty := &TaskConfigProperty{
	LanguageCode: jsii.String("languageCode"),

	// the properties below are optional
	DocumentClassificationConfig: &DocumentClassificationConfigProperty{
		Mode: jsii.String("mode"),

		// the properties below are optional
		Labels: []*string{
			jsii.String("labels"),
		},
	},
	EntityRecognitionConfig: &EntityRecognitionConfigProperty{
		EntityTypes: []interface{}{
			&EntityTypesListItemProperty{
				Type: jsii.String("type"),
			},
		},
	},
}

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-flywheel-taskconfig.html

type CfnFlywheel_VpcConfigProperty 

type CfnFlywheel_VpcConfigProperty struct {
	// The ID number for a security group on an instance of your private VPC.
	//
	// Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see [Security Groups for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) .
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-flywheel-vpcconfig.html#cfn-comprehend-flywheel-vpcconfig-securitygroupids
	//
	SecurityGroupIds *[]*string `field:"required" json:"securityGroupIds" yaml:"securityGroupIds"`
	// The ID for each subnet being used in your private VPC.
	//
	// This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see [VPCs and Subnets](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html) .
	// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-flywheel-vpcconfig.html#cfn-comprehend-flywheel-vpcconfig-subnets
	//
	Subnets *[]*string `field:"required" json:"subnets" yaml:"subnets"`
}

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job.

For more information, see [Amazon VPC](https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html) .

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

vpcConfigProperty := &VpcConfigProperty{
	SecurityGroupIds: []*string{
		jsii.String("securityGroupIds"),
	},
	Subnets: []*string{
		jsii.String("subnets"),
	},
}

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-flywheel-vpcconfig.html

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.