opensearchserverless

package
v0.1.309 Latest Latest
Warning

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

 Go to latest Published: May 11, 2025 License: Apache-2.0 Imports: 10 Imported by: 0

README

Amazon OpenSearch Serverless Construct Library

---

All classes are under active development and subject to non-backward compatible changes or removal in any future version. These are not subject to the Semantic Versioning model. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.

Language Package
Typescript Logo TypeScript @cdklabs/generative-ai-cdk-constructs
Python Logo Python cdklabs.generative_ai_cdk_constructs
Java Logo Java io.github.cdklabs.generative_ai_cdk_constructs
.Net .Net CdkLabs.GenerativeAICdkConstructs
Go Go github.com/cdklabs/generative-ai-cdk-constructs-go/generative-ai-cdk-constructs

This construct library extends the automatically generated L1 constructs to provide an L2 construct for a vector collection.

Table of contents

API

See the API documentation.

Vector Collection

This resource creates an Amazon OpenSearch Serverless collection configured for VECTORSEARCH. It creates default encryption, network, and data policies for use with Amazon Bedrock Knowledge Bases. For encryption, it uses the default AWS owned KMS key. It allows network connections from the public internet, but access is restricted to specific IAM principals.

Granting Data Access

The grantDataAccess method grants the specified role access to read and write the data in the collection.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewVectorCollection_Override 

func NewVectorCollection_Override(v VectorCollection, scope constructs.Construct, id *string, props *VectorCollectionProps)

Experimental.

func VectorCollection_IsConstruct 

func VectorCollection_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`. Experimental.

func VectorCollection_IsOwnedResource added in v0.1.288 

func VectorCollection_IsOwnedResource(construct constructs.IConstruct) *bool

Returns true if the construct was created by CDK, and false otherwise. Experimental.

func VectorCollection_IsResource added in v0.1.288 

func VectorCollection_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func VectorCollection_MetricAll added in v0.1.288 

func VectorCollection_MetricAll(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric

Return metrics for all vector collections. Experimental.

func VectorCollection_MetricAllIndexRequestCount added in v0.1.288 

func VectorCollection_MetricAllIndexRequestCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric

Metric for the total number of index requests across all collections. Experimental.

func VectorCollection_MetricAllSearchLatency added in v0.1.288 

func VectorCollection_MetricAllSearchLatency(props *awscloudwatch.MetricOptions) awscloudwatch.Metric

Metric for average search latency across all collections. Experimental.

func VectorCollection_MetricAllSearchRequestCount added in v0.1.288 

func VectorCollection_MetricAllSearchRequestCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric

Metric for the total number of search requests across all collections. Experimental.

Types

type CharacterFilterType 

type CharacterFilterType string

Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with the License. A copy of the License is located at 

http://www.apache.org/licenses/LICENSE-2.0

or in the 'license' file accompanying this file. This file is distributed on an 'AS IS' BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, express or implied. See the License for the specific language governing permissions and limitations under the License. Experimental. 

const (
	// Experimental.
	CharacterFilterType_ICU_NORMALIZER CharacterFilterType = "ICU_NORMALIZER"
)

type IVectorCollection added in v0.1.288 

type IVectorCollection interface {
	awscdk.IResource
	// Return the given named metric for this VectorCollection.
	// Experimental.
	Metric(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// Metric for the number of index requests.
	// Experimental.
	MetricIndexRequestCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// Metric for the search latency.
	// Experimental.
	MetricSearchLatency(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// Metric for the 90th percentile search latency.
	// Experimental.
	MetricSearchLatencyP90(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// Metric for the number of search requests.
	// Experimental.
	MetricSearchRequestCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// An IAM policy that allows API access to the collection.
	// Experimental.
	AossPolicy() awsiam.ManagedPolicy
	// The ARN of the collection.
	// Experimental.
	CollectionArn() *string
	// The ID of the collection.
	// Experimental.
	CollectionId() *string
	// The name of the collection.
	// Experimental.
	CollectionName() *string
	// Type of collection.
	// Experimental.
	CollectionType() VectorCollectionType
	// An OpenSearch Access Policy that allows access to the index.
	// Experimental.
	DataAccessPolicy() awsopensearchserverless.CfnAccessPolicy
	// Indicates whether standby replicas are enabled.
	// Experimental.
	StandbyReplicas() VectorCollectionStandbyReplicas
}

Interface representing a vector collection. Experimental.

func VectorCollection_FromCollectionAttributes added in v0.1.288 

func VectorCollection_FromCollectionAttributes(constructScope constructs.Construct, constructId *string, attrs *VectorCollectionAttributes) IVectorCollection

Import an existing collection using its attributes. Experimental.

type TokenFilterType 

type TokenFilterType string

TokenFilterType defines the available token filters for text analysis.

Token filters process tokens after they have been created by the tokenizer. They can modify, add, or remove tokens based on specific rules. Experimental. 

const (
	// Converts inflected Japanese words to their base form.
	// Experimental.
	TokenFilterType_KUROMOJI_BASEFORM TokenFilterType = "KUROMOJI_BASEFORM"
	// Tags words with their parts of speech in Japanese text analysis.
	// Experimental.
	TokenFilterType_KUROMOJI_PART_OF_SPEECH TokenFilterType = "KUROMOJI_PART_OF_SPEECH"
	// Reduces Japanese words to their stem form.
	// Experimental.
	TokenFilterType_KUROMOJI_STEMMER TokenFilterType = "KUROMOJI_STEMMER"
	// Normalizes CJK width differences by converting all characters to their fullwidth or halfwidth variants.
	// Experimental.
	TokenFilterType_CJK_WIDTH TokenFilterType = "CJK_WIDTH"
	// Removes Japanese stop words from text.
	// Experimental.
	TokenFilterType_JA_STOP TokenFilterType = "JA_STOP"
	// Converts all characters to lowercase.
	// Experimental.
	TokenFilterType_LOWERCASE TokenFilterType = "LOWERCASE"
	// Applies Unicode folding rules for better text matching.
	// Experimental.
	TokenFilterType_ICU_FOLDING TokenFilterType = "ICU_FOLDING"
	// Tags words with their parts of speech in Korean text analysis.
	// Experimental.
	TokenFilterType_NORI_PART_OF_SPEECH TokenFilterType = "NORI_PART_OF_SPEECH"
	// Converts Korean text to its reading form.
	// Experimental.
	TokenFilterType_NORI_READINGFORM TokenFilterType = "NORI_READINGFORM"
	// Normalizes Korean numbers to regular Arabic numbers.
	// Experimental.
	TokenFilterType_NORI_NUMBER TokenFilterType = "NORI_NUMBER"
)

type TokenizerType 

type TokenizerType string

Experimental. 

const (
	// Kuromoji tokenizer is used for Japanese text analysis and segmentation.
	// Experimental.
	TokenizerType_KUROMOJI_TOKENIZER TokenizerType = "KUROMOJI_TOKENIZER"
	// ICU tokenizer is used for Unicode text segmentation based on UAX #29 rules.
	// Experimental.
	TokenizerType_ICU_TOKENIZER TokenizerType = "ICU_TOKENIZER"
	// Nori tokenizer is used for Korean text analysis and segmentation.
	// Experimental.
	TokenizerType_NORI_TOKENIZER TokenizerType = "NORI_TOKENIZER"
)

type VectorCollection 

type VectorCollection interface {
	awscdk.Resource
	IVectorCollection
	// An IAM policy that allows API access to the collection.
	// Experimental.
	AossPolicy() awsiam.ManagedPolicy
	// The ARN of the collection.
	// Experimental.
	CollectionArn() *string
	// Experimental.
	CollectionEndpoint() *string
	// The ID of the collection.
	// Experimental.
	CollectionId() *string
	// The name of the collection.
	// Experimental.
	CollectionName() *string
	// Type of collection.
	// Experimental.
	CollectionType() VectorCollectionType
	// Experimental.
	DashboardEndpoint() *string
	// An OpenSearch Access Policy that allows access to the index.
	// Experimental.
	DataAccessPolicy() awsopensearchserverless.CfnAccessPolicy
	// The environment this resource belongs to.
	//
	// For resources that are created and managed by the CDK
	// (generally, those created by creating new class instances like Role, Bucket, etc.),
	// this is always the same as the environment of the stack they belong to;
	// however, for imported resources
	// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
	// that might be different than the stack they were imported into.
	// Experimental.
	Env() *awscdk.ResourceEnvironment
	// 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
	// Indicates whether standby replicas are enabled.
	// Experimental.
	StandbyReplicas() VectorCollectionStandbyReplicas
	// 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
	// Grants the specified role access to data in the collection.
	// Experimental.
	GrantDataAccess(grantee awsiam.IRole)
	// Return the given named metric for this VectorCollection.
	// Experimental.
	Metric(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// Metric for the number of index requests.
	// Experimental.
	MetricIndexRequestCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// Metric for the search latency.
	// Experimental.
	MetricSearchLatency(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// Metric for the 90th percentile search latency.
	// Experimental.
	MetricSearchLatencyP90(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// Metric for the number of search requests.
	// Experimental.
	MetricSearchRequestCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric
	// Returns a string representation of this construct.
	// Experimental.
	ToString() *string
}

Provides a vector search collection in Amazon OpenSearch Serverless. Experimental.

func NewVectorCollection 

func NewVectorCollection(scope constructs.Construct, id *string, props *VectorCollectionProps) VectorCollection

Experimental.

type VectorCollectionAttributes added in v0.1.288 

type VectorCollectionAttributes struct {
	// The ARN of the collection.
	// Experimental.
	CollectionArn *string `field:"required" json:"collectionArn" yaml:"collectionArn"`
	// The ID of the collection.
	// Experimental.
	CollectionId *string `field:"required" json:"collectionId" yaml:"collectionId"`
	// The name of the collection.
	// Experimental.
	CollectionName *string `field:"required" json:"collectionName" yaml:"collectionName"`
	// The type of collection.
	// Experimental.
	CollectionType VectorCollectionType `field:"required" json:"collectionType" yaml:"collectionType"`
	// The standby replicas configuration.
	// Experimental.
	StandbyReplicas VectorCollectionStandbyReplicas `field:"required" json:"standbyReplicas" yaml:"standbyReplicas"`
}

Attributes for importing an existing vector collection. Experimental.

type VectorCollectionProps 

type VectorCollectionProps struct {
	// The name of the collection.
	//
	// Must be between 3-32 characters long and contain only
	// lowercase letters, numbers, and hyphens.
	// Default: - A CDK generated name will be used.
	//
	// Experimental.
	CollectionName *string `field:"optional" json:"collectionName" yaml:"collectionName"`
	// Type of vector collection.
	// Default: - VECTORSEARCH.
	//
	// Experimental.
	CollectionType VectorCollectionType `field:"optional" json:"collectionType" yaml:"collectionType"`
	// A user defined IAM policy that allows API access to the collection.
	// Experimental.
	CustomAossPolicy awsiam.ManagedPolicy `field:"optional" json:"customAossPolicy" yaml:"customAossPolicy"`
	// Description for the collection.
	// Experimental.
	Description *string `field:"optional" json:"description" yaml:"description"`
	// Indicates whether to use standby replicas for the collection.
	// Default: VectorCollectionStandbyReplicas.ENABLED
	//
	// Experimental.
	StandbyReplicas VectorCollectionStandbyReplicas `field:"optional" json:"standbyReplicas" yaml:"standbyReplicas"`
	// A list of tags associated with the inference profile.
	// Experimental.
	Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}

Properties for configuring the vector collection. Experimental.

type VectorCollectionStandbyReplicas 

type VectorCollectionStandbyReplicas string

Configuration for standby replicas in a vector collection. Experimental. 

const (
	// Enable standby replicas for high availability.
	// Experimental.
	VectorCollectionStandbyReplicas_ENABLED VectorCollectionStandbyReplicas = "ENABLED"
	// Disable standby replicas to reduce costs.
	// Experimental.
	VectorCollectionStandbyReplicas_DISABLED VectorCollectionStandbyReplicas = "DISABLED"
)

type VectorCollectionType added in v0.1.288 

type VectorCollectionType string

The type of collection. Experimental. 

const (
	// Search – Full-text search that powers applications in your internal networks (content management systems, legal documents) and internet-facing applications, such as ecommerce website search and content search.
	// Experimental.
	VectorCollectionType_SEARCH VectorCollectionType = "SEARCH"
	// Time series – The log analytics segment that focuses on analyzing large volumes of semi-structured, machine-generated data in real-time for operational, security, user behavior, and business insights.
	// Experimental.
	VectorCollectionType_TIMESERIES VectorCollectionType = "TIMESERIES"
	// Vector search – Semantic search on vector embeddings that simplifies vector data management and powers machine learning (ML) augmented search experiences and generative AI applications, such as chatbots, personal assistants, and fraud detection.
	// Experimental.
	VectorCollectionType_VECTORSEARCH VectorCollectionType = "VECTORSEARCH"
)

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.