Defines the configuration options for connecting to Astra DB, DataStax's cloud-native Cassandra-as-a-Service. This interface specifies the necessary parameters required to establish a connection with an Astra DB instance, including authentication and targeting specific data centers or regions.

Properties:

  • token: The authentication token required for accessing the Astra DB instance. Essential for establishing a secure connection.
  • endpoint: Optional. The URL or network address of the Astra DB instance. Can be used to directly specify the connection endpoint.
  • datacenterID: Optional. The unique identifier of the data center to connect to. Used to compute the endpoint.
  • regionName: Optional. The region name of the Astra DB instance. Used to compute the endpoint. Default to the primary region.
  • bundleUrlTemplate: Optional. The URL template for downloading the secure connect bundle. Used to customize the bundle URL. "database_id" variable will be resolved at runtime.

Either endpoint or datacenterID must be provided to establish a connection to Astra DB.

interface AstraServiceProviderArgs {
    token: string;
    bundleUrlTemplate?: string;
    datacenterID?: string;
    endpoint?: string | URL;
    regionName?: string;
}

Properties

token: string
bundleUrlTemplate?: string
datacenterID?: string
endpoint?: string | URL
regionName?: string