Type Alias ListInstancesRequest

ListInstancesRequest: {
    name?: string;
    orderBy?: DocumentDB.v1beta1.ListInstancesRequestOrderBy;
    organizationId?: string;
    page?: number;
    pageSize?: number;
    projectId?: string;
    region?: Region;
    tags?: string[];
}

Type declaration

  • Optionalname?: string

    Lists Database Instances that match a name pattern.

  • OptionalorderBy?: DocumentDB.v1beta1.ListInstancesRequestOrderBy

    Criteria to use when ordering Database Instance listings.

  • OptionalorganizationId?: string

    Please use project_id instead.

  • Optionalpage?: number
  • OptionalpageSize?: number
  • OptionalprojectId?: string

    Project ID to list the Database Instance of.

  • Optionalregion?: Region

    Region to target. If none is passed will use default region from the config.

  • Optionaltags?: string[]

    List Database Instances that have a given tag.

Settings