Pinecone TypeScript SDK - v8.2.0
    Preparing search index...

    Interface CreateIndexFromBackupOptions

    The options for creating a new index from an existing backup.

    interface CreateIndexFromBackupOptions {
        backupId: string;
        deletionProtection?: string;
        name: string;
        readCapacity?: CreateIndexReadCapacity;
        tags?: { [key: string]: string };
    }
    Index
    backupId deletionProtection? name readCapacity? tags?
    backupId: string

    The ID of the backup to restore from.

    deletionProtection?: string

    Allows configuring deletion protection for the new index: 'enabled' or 'disabled'. Defaults to 'disabled'.

    name: string

    The name of the new index to create from the backup. Resource name must be 1-45 characters long, start and end with an alphanumeric character, and consist only of lower case alphanumeric characters or '-'.

    readCapacity?: CreateIndexReadCapacity

    Optional read capacity configuration for the restored index. For serverless backups, set this to create the restored index with dedicated read nodes (DRN) instead of defaulting to on-demand capacity.

    tags?: { [key: string]: string }

    Optional custom user tags to attach to the restored index. Keys must be 80 characters or less. Values must be 120 characters or less. Keys must be alphanumeric, '', or '-'. Values must be alphanumeric, ';', '@', '', '-', '.', '+', or ' '. To unset a key, set the value to be an empty string.

    Settings
    Member Visibility

    On This Page
    Properties