awscomprehend

package
v2.80.0 Latest Latest
Warning

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

Go to latest
Published: May 20, 2023 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 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(construct constructs.IConstruct) *bool

Check whether the given construct 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 NewCfnFlywheel_Override

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

Create a new `AWS::Comprehend::Flywheel`.

Types

type CfnFlywheel

type CfnFlywheel interface {
	awscdk.CfnResource
	awscdk.IInspectable
	// 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
	// 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.
	Tags() awscdk.TagManager
	// 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 CloudFormation `AWS::Comprehend::Flywheel`.

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"),
				},
			},
		},
	},
})

func NewCfnFlywheel

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

Create a new `AWS::Comprehend::Flywheel`.

type CfnFlywheelProps

type CfnFlywheelProps struct {
	// The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to access the flywheel data.
	DataAccessRoleArn *string `field:"required" json:"dataAccessRoleArn" yaml:"dataAccessRoleArn"`
	// Amazon S3 URI of the data lake location.
	DataLakeS3Uri *string `field:"required" json:"dataLakeS3Uri" yaml:"dataLakeS3Uri"`
	// Name for the flywheel.
	FlywheelName *string `field:"required" json:"flywheelName" yaml:"flywheelName"`
	// The Amazon Resource Number (ARN) of the active model version.
	ActiveModelArn *string `field:"optional" json:"activeModelArn" yaml:"activeModelArn"`
	// Data security configuration.
	DataSecurityConfig interface{} `field:"optional" json:"dataSecurityConfig" yaml:"dataSecurityConfig"`
	// Model type of the flywheel's model.
	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.
	Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
	// Configuration about the model associated with a flywheel.
	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"),
				},
			},
		},
	},
}

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.
	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"`.
	ModelKmsKeyId *string `field:"optional" json:"modelKmsKeyId" yaml:"modelKmsKeyId"`
	// ID for the AWS KMS key that Amazon Comprehend uses to encrypt the volume.
	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) .
	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"),
		},
	},
}

type CfnFlywheel_DocumentClassificationConfigProperty

type CfnFlywheel_DocumentClassificationConfigProperty struct {
	// Classification mode indicates whether the documents are `MULTI_CLASS` or `MULTI_LABEL` .
	Mode *string `field:"required" json:"mode" yaml:"mode"`
	// One or more labels to associate with the custom classifier.
	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"),
	},
}

type CfnFlywheel_EntityRecognitionConfigProperty

type CfnFlywheel_EntityRecognitionConfigProperty struct {
	// Up to 25 entity types that the model is trained to recognize.
	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"),
		},
	},
}

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), space, and , (comma).
	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"),
}

type CfnFlywheel_TaskConfigProperty

type CfnFlywheel_TaskConfigProperty struct {
	// Language code for the language that the model supports.
	LanguageCode *string `field:"required" json:"languageCode" yaml:"languageCode"`
	// Configuration required for a document classification model.
	DocumentClassificationConfig interface{} `field:"optional" json:"documentClassificationConfig" yaml:"documentClassificationConfig"`
	// Configuration required for an entity recognition model.
	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"),
			},
		},
	},
}

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) .
	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) .
	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"),
	},
}

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL