opensearchvectorindex

type Analyzer struct {
	// The analyzers to use.
	// Experimental.
	CharacterFilters *[]opensearchserverless.CharacterFilterType `field:"required" json:"characterFilters" yaml:"characterFilters"`
	// The token filters to use.
	// Experimental.
	TokenFilters *[]opensearchserverless.TokenFilterType `field:"required" json:"tokenFilters" yaml:"tokenFilters"`
	// The tokenizer to use.
	// Experimental.
	Tokenizer opensearchserverless.TokenizerType `field:"required" json:"tokenizer" yaml:"tokenizer"`
}

type MetadataManagementFieldProps struct {
	// The data type of the field.
	// Experimental.
	DataType *string `field:"required" json:"dataType" yaml:"dataType"`
	// Whether the field is filterable.
	// Experimental.
	Filterable *bool `field:"required" json:"filterable" yaml:"filterable"`
	// The name of the field.
	// Experimental.
	MappingField *string `field:"required" json:"mappingField" yaml:"mappingField"`
}

type VectorIndex interface {
	awscdk.Resource
	// The environment this resource belongs to.
	//
	// For resources that are created and managed in a Stack (those created by
	// creating new class instances like `new Role()`, `new Bucket()`, etc.), this
	// is always the same as the environment of the stack they belong to.
	//
	// For referenced resources (those obtained from referencing methods like
	// `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they might be
	// different than the stack they were imported into.
	// Experimental.
	Env() *interfaces.ResourceEnvironment
	// The name of the index.
	// Experimental.
	IndexName() *string
	// The tree node.
	// Experimental.
	Node() constructs.Node
	// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by CloudFormation
	// - a concrete name generated automatically during synthesis, in
	//   cross-environment scenarios.
	// Experimental.
	PhysicalName() *string
	// The stack in which this resource is defined.
	// Experimental.
	Stack() awscdk.Stack
	// The number of dimensions in the vector.
	// Experimental.
	VectorDimensions() *float64
	// The name of the vector field.
	// Experimental.
	VectorField() *string
	// Apply the given removal policy to this resource.
	//
	// 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`).
	// Experimental.
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	// Experimental.
	GeneratePhysicalName() *string
	// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
	//
	// Normally, this token will resolve to `arnAttr`, but if the resource is
	// referenced across environments, `arnComponents` will be used to synthesize
	// a concrete ARN with the resource's physical name. Make sure to reference
	// `this.physicalName` in `arnComponents`.
	// Experimental.
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
	//
	// Normally, this token will resolve to `nameAttr`, but if the resource is
	// referenced across environments, it will be resolved to `this.physicalName`,
	// which will be a concrete name.
	// Experimental.
	GetResourceNameAttribute(nameAttr *string) *string
	// Returns a string representation of this construct.
	// Experimental.
	ToString() *string
}

type VectorIndexProps struct {
	// The OpenSearch Vector Collection.
	// Experimental.
	Collection opensearchserverless.VectorCollection `field:"required" json:"collection" yaml:"collection"`
	// Experimental.
	DistanceType *string `field:"required" json:"distanceType" yaml:"distanceType"`
	// The name of the index.
	// Experimental.
	IndexName *string `field:"required" json:"indexName" yaml:"indexName"`
	// The metadata management fields.
	// Experimental.
	Mappings *[]*MetadataManagementFieldProps `field:"required" json:"mappings" yaml:"mappings"`
	// Experimental.
	Precision *string `field:"required" json:"precision" yaml:"precision"`
	// The number of dimensions in the vector.
	// Experimental.
	VectorDimensions *float64 `field:"required" json:"vectorDimensions" yaml:"vectorDimensions"`
	// The name of the vector field.
	// Experimental.
	VectorField *string `field:"required" json:"vectorField" yaml:"vectorField"`
	// The analyzer to use.
	// Default: - No analyzer.
	//
	// Experimental.
	Analyzer *Analyzer `field:"optional" json:"analyzer" yaml:"analyzer"`
}