Skip to main content

SvectorDB::VectorDatabase::ApiKey

Generates an API key to access a SvectorDB serverless vector database, 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::ApiKey",
    "Properties" : {
        "IntegrationId" : String,
        "DatabaseId" : String,
    }
}

YAML

Type: SvectorDB::VectorDatabase::ApiKey
Properties:
    IntegrationId: String
    DatabaseId: String

Properties

IntegrationId

Integration ID

Required: Yes

Type: String

Update requires: Replacement

DatabaseId

Database ID

Required: Yes

Type: String

Update requires: Replacement

Return Values

Ref

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

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.

ApiKey

API key