Type Alias ListDatabasesRequest

ListDatabasesRequest: {
    instanceId: string;
    managed?: boolean;
    name?: string;
    orderBy?: DocumentDB.v1beta1.ListDatabasesRequestOrderBy;
    owner?: string;
    page?: number;
    pageSize?: number;
    region?: Region;
}

Type declaration

  • instanceId: string

    UUID of the Database Instance to list the databases of.

  • Optionalmanaged?: boolean

    Defines whether or not the database is managed.

  • Optionalname?: string

    Name of the database.

  • OptionalorderBy?: DocumentDB.v1beta1.ListDatabasesRequestOrderBy

    Criteria to use when ordering database listing.

  • Optionalowner?: string

    User that owns this database.

  • Optionalpage?: number
  • OptionalpageSize?: number
  • Optionalregion?: Region

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

Settings