Interface ServerlessSpec

Configuration needed to deploy a serverless index.

Export

ServerlessSpec

interface ServerlessSpec {
    cloud: string;
    readCapacity?: ReadCapacity;
    region: string;
    schema?: MetadataSchema;
    sourceCollection?: string;
}

Properties

cloud readCapacity? region schema? sourceCollection?

Properties

cloud

cloud: string

The public cloud where you would like your index hosted. Possible values: gcp, aws, or azure.

Memberof

ServerlessSpec

OptionalreadCapacity

readCapacity?: ReadCapacity

Memberof

ServerlessSpec

region

region: string

The region where you would like your index to be created.

Memberof

ServerlessSpec

Optionalschema

schema?: MetadataSchema

Memberof

ServerlessSpec

OptionalsourceCollection

sourceCollection?: string

The name of the collection to be used as the source for the index.

Memberof

ServerlessSpec

Settings

Member Visibility

On This Page

Properties