Interface AstraAvailableRegionInfo

Overview

Information about an available region for Astra database deployments.

This provides details about each available region including classification, cloud provider, display name, and availability status.

Example

// Basic usage
const regions = await admin.findAvailableRegions();
console.log(regions[0].displayName); // 'Moncks Corner, South Carolina'

// Further filterting & transformation may be done using native list methods
const awsRegions = regions.filter(region => region.cloudProvider === 'AWS');

See

  • AstraAdmin.findAvailableRegions
  • AstraFindAvailableRegionsOptions
interface AstraAvailableRegionInfo {
    classification: AstraRegionClassification;
    cloudProvider: AstraDatabaseCloudProvider;
    displayName: string;
    enabled: boolean;
    name: string;
    reservedForQualifiedUsers: boolean;
    zone: AstraRegionZone;
}

Properties

classification cloudProvider displayName enabled name reservedForQualifiedUsers zone

Properties

classification

classification: AstraRegionClassification

Represents the classification tier of an Astra database region.

Region availability will depend on the user's account level.

Example

'standard'

cloudProvider

cloudProvider: AstraDatabaseCloudProvider

The cloud provider hosting this region.

Example

'GCP'

displayName

displayName: string

A human-readable display name for the region.

Example

'Moncks Corner, South Carolina'

enabled

enabled: boolean

Whether this region is currently enabled for use.

✏️Note: If AstraFindAvailableRegionsOptions.onlyOrgEnabledRegions is false, and enabled is still true, it does not guarantee that the region is usable by the current organization.

name

name: string

The unique identifier for the region.

Example

'us-east1'

reservedForQualifiedUsers

reservedForQualifiedUsers: boolean

Whether this region is reserved for qualified users only, meaning special access is required to use it.

zone

zone: AstraRegionZone

The geographic zone where this region is located.

Example

'na'

Settings

Member Visibility

Theme

On This Page

classificationcloudProviderdisplayNameenablednamereservedForQualifiedUserszone