Contains details about the Managed Cluster configuration of the knowledge base in Amazon OpenSearch Service. For more information, see Create a vector index in OpenSearch Managed Cluster.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{
"DomainArn" : String
,
"DomainEndpoint" : String
,
"FieldMapping" : OpenSearchManagedClusterFieldMapping
,
"VectorIndexName" : String
}
YAML
DomainArn: String
DomainEndpoint: String
FieldMapping:
OpenSearchManagedClusterFieldMapping
VectorIndexName: String
Properties
DomainArn
-
The Amazon Resource Name (ARN) of the OpenSearch domain.
Required: Yes
Type: String
Pattern:
^arn:aws(|-cn|-us-gov|-iso):es:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:domain/[a-z][a-z0-9-]{3,28}$
Maximum:
2048
Update requires: Replacement
DomainEndpoint
-
The endpoint URL the OpenSearch domain.
Required: Yes
Type: String
Pattern:
^https://.*$
Maximum:
2048
Update requires: Replacement
FieldMapping
-
Contains the names of the fields to which to map information about the vector store.
Required: Yes
Type: OpenSearchManagedClusterFieldMapping
Update requires: Replacement
VectorIndexName
-
The name of the vector store.
Required: Yes
Type: String
Pattern:
^(?![\-_+.])[a-z0-9][a-z0-9\-_\.]*$
Minimum:
1
Maximum:
2048
Update requires: Replacement