Skip to main content

SvectorDB::VectorDatabase::Database

Creates a serverless vector database with SvectorDB, sign up at https://svectordb.com to get started

Syntax​

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON​

{
    "Type" : "SvectorDB::VectorDatabase::Database",
    "Properties" : {
        "IntegrationId" : String,
        "Name" : String,
        "Type" : String,
        "Metric" : String,
        "Dimension" : Integer
    }
}

YAML​

Type: SvectorDB::VectorDatabase::Database
Properties:
    IntegrationId: String
    Name: String
    Type: String
    Metric: String
    Dimension: Integer

Properties​

IntegrationId​

Integration ID

Required: Yes

Type: String

Update requires: Replacement

Name​

Name that appears in the SvectorDB console

Required: No

Type: String

Minimum Length: 1

Maximum Length: 256

Pattern: ^[A-Za-z0-9 -_]+$

Update requires: No interruption

Type​

Required: No

Type: String

Allowed Values: SANDBOX | STANDARD

Update requires: Replacement

Metric​

Required: Yes

Type: String

Allowed Values: EUCLIDEAN | DOT_PRODUCT | COSINE

Update requires: Replacement

Dimension​

Required: Yes

Type: Integer

Update requires: Replacement

Return Values​

Ref​

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the Id.

Fn::GetAtt​

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Id​

Database ID